diff --git a/.gitignore b/.gitignore index 45ebd70..da0ef4b 100644 --- a/.gitignore +++ b/.gitignore @@ -30,10 +30,23 @@ go.work.sum # Editor/IDE .idea/ .vscode/ +.DS_Store +.cursorrules # Binaries -/databricks-exporter +databricks-exporter +bin/ +data-alloy/ # Test & development scripts test_tables.sh -lefthook.yml \ No newline at end of file +lefthook.yml + +# build artifacts from `promu crossbuild` +.build + +# build artifacts for mixin +mixin/prometheus_alerts.yaml + +# Dependency directories (remove the comment below to include it) +# vendor/ diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..0a3994a --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,33 @@ +# golangci-lint configuration +# https://golangci-lint.run/usage/configuration/ + +run: + timeout: 5m + +linters: + enable: + - errcheck + - gosimple + - govet + - ineffassign + - staticcheck + - unused + - gofmt + - goimports + +linters-settings: + errcheck: + # Ignore log.Log() return values - standard Go logging pattern + exclude-functions: + - (github.com/go-kit/log.Logger).Log + - (*github.com/go-kit/log.Logger).Log + - (github.com/go-kit/log/level.Logger).Log + +issues: + # Don't limit the number of issues + max-issues-per-linter: 0 + max-same-issues: 0 + exclude-dirs: + - mixin + - vendor + diff --git a/Dockerfile b/Dockerfile index 885c8ed..ba0d60e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ ARG ARCH="amd64" ARG OS="linux" -FROM quay.io/prometheus/busybox-${OS}-${ARCH}:latest +FROM quay.io/prometheus/busybox-${OS}-${ARCH}:4eb7e9b ARG ARCH="amd64" ARG OS="linux" diff --git a/Makefile b/Makefile index bb79d07..be5d046 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,107 @@ -DOCKER_ARCHS ?= amd64 armv7 arm64 -DOCKER_IMAGE_NAME ?= databricks-exporter +# Databricks Prometheus Exporter Makefile -ALL_SRC := $(shell find . -name '*.go' -o -name 'Dockerfile*' -type f | sort) - -all:: vet common-all +# Docker settings +DOCKER_ARCHS ?= amd64 armv7 arm64 +DOCKER_IMAGE_NAME ?= databricks-exporter +# Build settings +BIN_DIR := bin +BINARY_NAME := databricks-exporter +GO := go +GOFLAGS := +pkgs := ./... +# Include common Prometheus Makefile targets include Makefile.common +.PHONY: all +all: check build + +# ============================================================================ +# Quality checks +# ============================================================================ + +.PHONY: check +check: vet lint fmt test-exporter-unit ## Run all quality checks (vet, lint, fmt, unit-tests) + +.PHONY: vet +vet: ## Run go vet + @echo ">> running go vet" + $(GO) vet $(GOFLAGS) $(pkgs) + +.PHONY: lint +lint: ## Run golangci-lint (includes deadcode analysis) + @echo ">> running golangci-lint" + @if command -v golangci-lint >/dev/null 2>&1; then \ + golangci-lint run $(pkgs); \ + else \ + echo "golangci-lint not installed, skipping (install: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest)"; \ + fi + +.PHONY: fmt +fmt: ## Run gofmt and check for formatting issues + @echo ">> checking code formatting" + @fmtRes=$$(gofmt -l $$(find . -name '*.go' -not -path './vendor/*' -not -path './mixin/*')); \ + if [ -n "$${fmtRes}" ]; then \ + echo "gofmt found issues in:"; echo "$${fmtRes}"; \ + echo "Run 'make fmt-fix' to fix"; \ + exit 1; \ + fi + @echo ">> formatting OK" + +.PHONY: fmt-fix +fmt-fix: ## Auto-fix formatting issues + @echo ">> fixing code formatting" + $(GO) fmt $(pkgs) + +.PHONY: test +test: test-exporter-unit test-exporter-e2e ## Run all tests (unit + e2e) + +.PHONY: test-exporter-unit +test-exporter-unit: ## Run unit tests only + @echo ">> running unit tests" + $(GO) test -race $(GOFLAGS) $(pkgs) + +.PHONY: test-exporter-e2e +test-exporter-e2e: ## Run e2e/integration tests only (requires Databricks credentials) + @echo ">> running e2e/integration tests (exporter + Databricks connection)" + $(GO) test -tags=integration -v -timeout 10m ./collector/... + +.PHONY: test-coverage +test-coverage: ## Run tests with coverage report + @echo ">> running tests with coverage" + $(GO) test -race -coverprofile=coverage.out $(GOFLAGS) $(pkgs) + $(GO) tool cover -html=coverage.out -o coverage.html + @echo ">> coverage report: coverage.html" + +# ============================================================================ +# Build +# ============================================================================ + +.PHONY: build +build: $(BIN_DIR)/$(BINARY_NAME) ## Build the exporter binary + +$(BIN_DIR)/$(BINARY_NAME): + @echo ">> building $(BINARY_NAME)" + @mkdir -p $(BIN_DIR) + $(GO) build $(GOFLAGS) -o $(BIN_DIR)/$(BINARY_NAME) ./cmd/databricks-exporter/ + +.PHONY: build-all +build-all: promu ## Build for all platforms using promu + @echo ">> building binaries for all platforms" + $(PROMU) crossbuild + +.PHONY: clean +clean: ## Remove build artifacts + @echo ">> cleaning build artifacts" + rm -rf $(BIN_DIR) + rm -f coverage.out coverage.html + +# ============================================================================ +# Help +# ============================================================================ + +.PHONY: help +help: ## Show this help + @echo "Available targets:" + @grep -E '^[a-zA-Z0-9_-]+:.*##' Makefile | sed 's/:.*##/:/' | awk -F: '{printf " \033[36m%-20s\033[0m %s\n", $$1, $$2}' diff --git a/README.md b/README.md index 92de619..6612d4b 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,72 @@ # databricks-prometheus-exporter -Exports [Databricks](https://databricks.com) billing and usage statistics via HTTP for Prometheus consumption. +Exports [Databricks](https://databricks.com) metrics via HTTP for Prometheus consumption. ## Overview -This exporter connects to a Databricks SQL Warehouse and queries the `system.billing.account_prices` table to retrieve billing information. The metrics are exposed in Prometheus format, allowing you to monitor and analyze your Databricks usage and costs. +This exporter connects to a Databricks SQL Warehouse and queries Databricks System Tables to collect metrics about billing, job runs, pipeline executions, and SQL query performance. The metrics are exposed in Prometheus format, making it easy to monitor and analyze your Databricks workloads. ## Configuration -### Command line flags +### Command-line flags The exporter may be configured through its command line flags: -``` - -h, --help Show context-sensitive help (also try --help-long and --help-man). - --web.listen-address=:9976 ... Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. - --web.config.file="" Path to configuration file that can enable TLS or authentication. - --web.telemetry-path="/metrics" Path under which to expose metrics. - --server-hostname=HOSTNAME The Databricks workspace hostname (e.g., dbc-abc123-def456.cloud.databricks.com). - --http-path=HTTP-PATH The HTTP path of the SQL warehouse (e.g., /sql/1.0/warehouses/abc123def456). - --client-id=CLIENT-ID The OAuth2 Client ID (Application ID) for Service Principal authentication. - --client-secret=CLIENT-SECRET The OAuth2 Client Secret for Service Principal authentication. - --catalog="system" The catalog to use when querying. - --schema="billing" The schema to use when querying. - --version Show application version. - --log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error] - --log.format=logfmt Output format of log messages. One of: [logfmt, json] -``` +| Flag | Default | Description | +|------|---------|-------------| +| `--web.listen-address` | `:9976` | Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. | +| `--web.config.file` | `""` | Path to configuration file that can enable TLS or authentication. | +| `--web.telemetry-path` | `/metrics` | Path under which to expose metrics. | +| `--server-hostname` | *required* | The Databricks workspace hostname (e.g., `dbc-abc123.cloud.databricks.com`). | +| `--warehouse-http-path` | *required* | The HTTP path of the SQL Warehouse (e.g., `/sql/1.0/warehouses/abc123`). | +| `--client-id` | *required* | The OAuth2 Client ID (Application ID) for Service Principal authentication. | +| `--client-secret` | *required* | The OAuth2 Client Secret for Service Principal authentication. | +| `--query-timeout` | `5m` | Timeout for database queries. | +| `--billing-lookback` | `24h` | How far back to look for billing data. See [Lookback Windows](#lookback-windows). | +| `--jobs-lookback` | `4h` | How far back to look for job runs. See [Lookback Windows](#lookback-windows). | +| `--pipelines-lookback` | `4h` | How far back to look for pipeline runs. See [Lookback Windows](#lookback-windows). | +| `--queries-lookback` | `2h` | How far back to look for SQL warehouse queries. See [Lookback Windows](#lookback-windows). | +| `--sla-threshold` | `3600` | Duration threshold (in seconds) for job SLA miss detection. | +| `--collect-task-retries` | `false` | Collect task retry metrics (high cardinality due to `task_key` label). | +| `--table-check-interval` | `10` | Number of scrapes between table availability checks (for optional tables like pipelines). | +| `--log.level` | `info` | Only log messages with the given severity or above. One of: `debug`, `info`, `warn`, `error`. | +| `--log.format` | `logfmt` | Output format of log messages. One of: `logfmt`, `json`. | Example usage: ```sh ./databricks-exporter \ --server-hostname=.cloud.databricks.com \ - --http-path=/sql/1.0/warehouses/abc123def456 \ - --client-id=> \ + --warehouse-http-path=/sql/1.0/warehouses/abc123def456 \ + --client-id= \ --client-secret= ``` -### Environment Variables +### Environment variables Alternatively, the exporter may be configured using environment variables: -| Name | Description | -| ---------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| DATABRICKS_EXPORTER_SERVER_HOSTNAME | The Databricks workspace hostname (e.g., dbc-abc123-def456.cloud.databricks.com). | -| DATABRICKS_EXPORTER_HTTP_PATH | The HTTP path of the SQL warehouse (e.g., /sql/1.0/warehouses/abc123def456). | -| DATABRICKS_EXPORTER_CLIENT_ID | The OAuth2 Client ID (Application ID) for Service Principal authentication. | -| DATABRICKS_EXPORTER_CLIENT_SECRET | The OAuth2 Client Secret for Service Principal authentication. | -| DATABRICKS_EXPORTER_CATALOG | The catalog to use when querying (default: system). | -| DATABRICKS_EXPORTER_SCHEMA | The schema to use when querying (default: billing). | -| DATABRICKS_EXPORTER_WEB_TELEMETRY_PATH | Path under which to expose metrics (default: /metrics). | +| Name | Description | +|------|-------------| +| `DATABRICKS_EXPORTER_SERVER_HOSTNAME` | The Databricks workspace hostname. | +| `DATABRICKS_EXPORTER_WAREHOUSE_HTTP_PATH` | The HTTP path of the SQL Warehouse. | +| `DATABRICKS_EXPORTER_CLIENT_ID` | The OAuth2 Client ID for Service Principal authentication. | +| `DATABRICKS_EXPORTER_CLIENT_SECRET` | The OAuth2 Client Secret for Service Principal authentication. | +| `DATABRICKS_EXPORTER_WEB_TELEMETRY_PATH` | Path under which to expose metrics. | +| `DATABRICKS_EXPORTER_QUERY_TIMEOUT` | Timeout for database queries. | +| `DATABRICKS_EXPORTER_BILLING_LOOKBACK` | How far back to look for billing data. | +| `DATABRICKS_EXPORTER_JOBS_LOOKBACK` | How far back to look for job runs. | +| `DATABRICKS_EXPORTER_PIPELINES_LOOKBACK` | How far back to look for pipeline runs. | +| `DATABRICKS_EXPORTER_QUERIES_LOOKBACK` | How far back to look for SQL warehouse queries. | +| `DATABRICKS_EXPORTER_SLA_THRESHOLD` | Duration threshold (in seconds) for job SLA miss detection. | +| `DATABRICKS_EXPORTER_COLLECT_TASK_RETRIES` | Collect task retry metrics (set to `true` to enable). | +| `DATABRICKS_EXPORTER_TABLE_CHECK_INTERVAL` | Number of scrapes between table availability checks. | Example usage: ```sh export DATABRICKS_EXPORTER_SERVER_HOSTNAME="dbc-abc123-def456.cloud.databricks.com" -export DATABRICKS_EXPORTER_HTTP_PATH="/sql/1.0/warehouses/abc123def456" +export DATABRICKS_EXPORTER_WAREHOUSE_HTTP_PATH="/sql/1.0/warehouses/abc123def456" export DATABRICKS_EXPORTER_CLIENT_ID="4a8adace-cdf5-4489-b9c2-2b6f9dd7682f" export DATABRICKS_EXPORTER_CLIENT_SECRET="your-client-secret-here" @@ -65,19 +75,19 @@ export DATABRICKS_EXPORTER_CLIENT_SECRET="your-client-secret-here" ## Authentication -### Service Principal OAuth2 Authentication +### Service principal OAuth2 authentication The exporter uses OAuth2 Machine-to-Machine (M2M) authentication with Databricks Service Principals, following Databricks' recommended security practices. #### Prerequisites -1. **Unity Catalog Enabled**: Your Databricks workspace must have Unity Catalog enabled to access the `system.billing.account_prices` table. +1. **Unity Catalog Enabled**: Your Databricks workspace must have Unity Catalog enabled to access System Tables. 2. **Service Principal**: Create a Service Principal in your Databricks workspace with appropriate permissions. 3. **SQL Warehouse**: Have a running SQL Warehouse (or one configured to auto-start) for executing queries. -#### Setting up a Service Principal +#### Setting up a service principal 1. Log into your Databricks workspace 2. Go to **Settings** → **Admin Console** → **Service Principals** @@ -86,60 +96,63 @@ The exporter uses OAuth2 Machine-to-Machine (M2M) authentication with Databricks 5. Click **Generate Secret** under OAuth Secrets 6. Copy and securely store the **Client Secret** (you won't see it again!) -#### Required Permissions +#### Required permissions + +The Service Principal needs access to the Databricks workspace, permission to use the SQL Warehouse, and appropriate Unity Catalog permissions on System Tables. + +Run these SQL commands as a Databricks admin to grant the necessary permissions (replace `` with your Service Principal's Application ID): + +```sql +GRANT MANAGE ON CATALOG system TO ``; + +GRANT USE CATALOG ON CATALOG system TO ``; + +GRANT USE SCHEMA ON SCHEMA system.billing TO ``; + +GRANT SELECT ON SCHEMA system.billing TO ``; + +GRANT USE SCHEMA ON SCHEMA system.query TO ``; -The Service Principal needs: -- Access to the Databricks workspace -- Permission to use the SQL Warehouse -- Read access to `system.billing.account_prices` table (requires account-level permissions) +GRANT SELECT ON SCHEMA system.query TO ``; -### Getting Required Configuration Values +GRANT USE SCHEMA ON SCHEMA system.lakeflow TO ``; -#### Server Hostname +GRANT SELECT ON SCHEMA system.lakeflow TO ``; + +GRANT SELECT ON TABLE system.lakeflow.pipeline_update_timeline TO ``; +``` + +These grants provide: +- Management and usage rights on the `system` catalog +- Schema-level `USE` and `SELECT` permissions on `system.billing`, `system.query`, and `system.lakeflow` +- Access to all tables within these schemas including: + - `system.billing.usage`, `system.billing.list_prices` + - `system.lakeflow.job_run_timeline`, `system.lakeflow.job_task_run_timeline`, `system.lakeflow.pipeline_update_timeline` + - `system.query.history` + +### Getting required configuration values + +#### Server hostname - Found in your Databricks workspace URL - Example: `dbc-abc123-def456.cloud.databricks.com` - Remove the `https://` prefix -#### HTTP Path +#### Warehouse HTTP path 1. Go to **SQL Warehouses** in your Databricks workspace 2. Select your SQL Warehouse 3. Click **Connection Details** tab 4. Copy the **HTTP Path** (format: `/sql/1.0/warehouses/`) -#### Client ID and Client Secret +#### Client ID and client secret 1. Go to **Settings** → **Admin Console** → **Service Principals** 2. Find your Service Principal 3. The **Application ID** is your **Client ID** 4. Generate and copy the **Client Secret** -## Metrics - -The exporter provides the following metrics: - -### `databricks_billing_account_price` - -Account pricing information from the `system.billing.account_prices` table, aggregated over the last 7 days. +## Metrics and system tables -**Labels:** -- `account_id`: Databricks account identifier -- `sku_name`: SKU/product name -- `cloud`: Cloud provider (AWS, Azure, GCP) -- `currency_code`: Currency code (e.g., USD, EUR) -- `usage_unit`: Unit of measurement for usage - -**Type:** Gauge - -**Value:** Average pricing for the SKU over the collection period - -### `databricks_up` - -Metric indicating the status of the exporter collection. - -**Type:** Gauge - -**Values:** -- `1`: Connection to Databricks was successful, and all available metrics were collected -- `0`: The exporter failed to collect one or more metrics due to connection issues +- **[Metrics Reference](docs/metrics-reference.md)** — Complete list of exported metrics with descriptions, labels, and types +- **[System Tables Reference](docs/databricks-system-tables.md)** — Databricks system tables queried by the exporter ## Building @@ -160,52 +173,174 @@ Run the container: ```sh docker run -p 9976:9976 \ -e DATABRICKS_EXPORTER_SERVER_HOSTNAME="dbc-abc123-def456.cloud.databricks.com" \ - -e DATABRICKS_EXPORTER_HTTP_PATH="/sql/1.0/warehouses/abc123def456" \ + -e DATABRICKS_EXPORTER_WAREHOUSE_HTTP_PATH="/sql/1.0/warehouses/abc123def456" \ -e DATABRICKS_EXPORTER_CLIENT_ID="your-client-id" \ -e DATABRICKS_EXPORTER_CLIENT_SECRET="your-client-secret" \ databricks-exporter ``` -## Prometheus Configuration +## Prometheus configuration Add the exporter as a scrape target in your Prometheus configuration: ```yaml scrape_configs: - job_name: 'databricks' + scrape_interval: 10m + scrape_timeout: 9m static_configs: - targets: ['localhost:9976'] ``` +### Scrape interval requirements + +| Setting | Minimum | Maximum | Recommended | +|---------|---------|---------|-------------| +| `scrape_interval` | 10m | 30m | 10m | +| `scrape_timeout` | 9m | 29m | 9m | + +**Why these constraints?** + +- **Minimum 10 minutes**: The exporter queries Databricks System Tables which can take 30-120 seconds depending on data volume. Scraping more frequently wastes resources and may cause overlapping scrapes. + +- **Maximum 30 minutes**: The mixin dashboards use `last_over_time(...[30m:])` to bridge gaps between scrapes. Intervals longer than 30 minutes will cause gaps in dashboard visualizations. + +- **Timeout < Interval**: Always set `scrape_timeout` less than `scrape_interval` to prevent overlapping scrapes. A 1-minute buffer (e.g., 9m timeout for 10m interval) is recommended. + +### Grafana Alloy configuration + +If using Grafana Alloy instead of Prometheus: + +```alloy +prometheus.scrape "databricks" { + targets = [{ + __address__ = "localhost:9976", + }] + + forward_to = [prometheus.remote_write.default.receiver] + scrape_interval = "10m" + scrape_timeout = "9m" +} +``` + +### Lookback windows + +The exporter uses **sliding window queries** to collect metrics from Databricks System Tables. Each scrape queries data from `now - lookback` to `now`, meaning: + +- Metrics represent counts/aggregates over the lookback window +- Values can decrease as older data "slides out" of the window +- The lookback must be long enough to ensure data continuity between scrapes + +#### Default lookback windows + +| Domain | Lookback | Rationale | +|--------|----------|-----------| +| Billing | 24h | Databricks billing data has 24-48h lag; daily granularity | +| Jobs | 4h | Covers multiple scrape intervals with safety margin | +| Pipelines | 4h | Covers multiple scrape intervals with safety margin | +| Queries | 2h | SQL queries are more frequent; shorter window sufficient | + +#### Lookback vs scrape interval relationship + +The lookback window must be **significantly larger** than the scrape interval to prevent data loss: + +``` +Minimum safe lookback = scrape_interval × 4 +``` + +| Scrape Interval | Minimum Lookback | Recommended Lookback | +|-----------------|------------------|----------------------| +| 10m | 40m | 2h+ | +| 15m | 1h | 2h+ | +| 30m | 2h | 4h+ | + +**Why this matters:** + +1. **Data continuity**: If a job completes at time T, it appears in scrapes from T to T+lookback. With a 10m scrape interval and 4h lookback, that job appears in ~24 consecutive scrapes. + +2. **Missed scrapes**: If a scrape fails or is delayed, the next scrape still captures the data because the lookback window overlaps. + +3. **Dashboard accuracy**: The mixin dashboards use `last_over_time([30m:])` to bridge gaps. This assumes data points exist within each 30-minute window. + +#### Customizing lookback windows + +You can adjust lookback windows based on your workload patterns: + +```sh +# For high-frequency job environments (many short jobs) +./databricks-exporter --jobs-lookback=2h --pipelines-lookback=2h + +# For low-frequency batch environments (few long jobs) +./databricks-exporter --jobs-lookback=8h --pipelines-lookback=8h +``` + +**Trade-offs:** +- Longer lookback = more data per scrape = slower queries = higher Databricks costs +- Shorter lookback = risk of missing data if scrapes are delayed + ## Troubleshooting -### Authentication Errors (401 Unauthorized) +### Authentication errors (401 Unauthorized) If you see authentication errors: - Verify your Client ID (Application ID) is correct - Ensure the Client Secret hasn't expired - Check that the Service Principal has access to the workspace -### Credit Exhaustion (400 Bad Request) +### Credit exhaustion (400 Bad Request) Error: `Sorry, cannot run the resource because you've exhausted your available credits` This means your Databricks account has run out of credits. Add a payment method or credits to your account to continue. -### Connection Errors +### Connection errors - Ensure the SQL Warehouse is running (or set to auto-start) -- Verify the HTTP Path is correct (should start with `/sql/1.0/warehouses/`) +- Verify the Warehouse HTTP Path is correct (should start with `/sql/1.0/warehouses/`) - Check that the Server Hostname doesn't include `https://` -### No Billing Data +### No metrics appearing -If `databricks_up` is 1 but no billing metrics appear: +If `databricks_exporter_up` is 1 but some metrics don't appear: +- Some metrics only appear when there's data to report (e.g., no retries means no retry metric) +- Billing metrics require recent usage data (check the last 30 days) +- Job and pipeline metrics require recent executions (check the last 24 hours) +- Query metrics require recent SQL activity (check the last hour) - Verify Unity Catalog is enabled on your workspace -- Ensure the Service Principal has account-level permissions to read billing data -- Check that data exists in `system.billing.account_prices` table +- Ensure the Service Principal has permissions to read all System Tables + +### Pipeline metrics not available (TABLE_OR_VIEW_NOT_FOUND) + +If you see errors like: +``` +TABLE_OR_VIEW_NOT_FOUND: The table or view `system`.`lakeflow`.`pipeline_update_timeline` cannot be found +``` + +**Cause:** The `system.lakeflow.pipeline_update_timeline` table exists in Databricks, but the Service Principal likely doesn't have `SELECT` permission on it. + +**Impact:** Pipeline metrics (`databricks_pipeline_*`) will not be collected, but all other metrics (jobs, billing, queries) will continue to work normally. The exporter will check table availability periodically and automatically resume collection if permissions are granted. + +**Verification:** Run this query in your Databricks SQL Warehouse to check if the table exists: +```sql +SELECT COUNT(*) FROM system.lakeflow.pipeline_update_timeline LIMIT 1; +``` + +If you get a permissions error instead of "table not found", this confirms it's a permissions issue. + +**Solutions:** +1. **Grant Permissions** - Ensure all required permissions are granted as described in the [Required Permissions](#required-permissions) section above +2. **Verify Schema Access** - Confirm the Service Principal has `USE SCHEMA` and `SELECT` on `system.lakeflow` +3. **Automatic Recovery** - Once permissions are granted, the exporter will automatically detect the table is available and resume collection within ~10 scrapes (typically ~10 minutes) + +The exporter now handles this gracefully: +- Checks table availability at startup and periodically +- Logs a clear warning once (not every scrape) +- Automatically resumes collection when permissions are fixed +- Continues collecting all other metrics normally + +For more information, see the [Known Limitations section in the mixin README](mixin/README.md#known-limitations). -### Debug Logging +### Debug logging Enable debug logging for more detailed information: diff --git a/TESTING.md b/TESTING.md deleted file mode 100644 index 57685f7..0000000 --- a/TESTING.md +++ /dev/null @@ -1,91 +0,0 @@ -# Testing - -This document describes the test suite for the Databricks Prometheus Exporter. - -## Running Tests - -### Run all tests -```sh -go test ./... -``` - -### Run tests with verbose output -```sh -go test ./... -v -``` - -### Run tests with coverage -```sh -go test ./... -cover -``` - -### Run tests for a specific package -```sh -go test ./collector/... -v -``` - -## Test Coverage - -Current test coverage: -- **collector package**: 55.1% of statements - -## Test Structure - -### Config Tests (`collector/config_test.go`) - -Tests for configuration validation: -- **TestConfigValidate**: Comprehensive validation tests for all config fields - - Valid configuration - - Missing required fields (server hostname, HTTP path, client ID, client secret, catalog, schema) - - Empty string validation -- **TestConfigValidationOrder**: Ensures validation errors occur in a predictable order - -Total: 13 test cases - -### Collector Tests (`collector/collector_test.go`) - -Tests for the Prometheus collector implementation: -- **TestNewCollector**: Verifies collector initialization -- **TestCollectorDescribe**: Tests metric descriptor registration -- **TestCollectorCollect_DatabaseConnectionFailure**: Validates behavior when database connection fails -- **TestCollectorMetricNames**: Verifies correct metric names are registered -- **TestCollectorLabels**: Tests label constant definitions -- **TestNamespaceConstant**: Validates the namespace constant -- **TestOpenDatabricksDatabase_ValidatesConnection**: Tests database connector creation - -Total: 7 test cases - -### Query Tests (`collector/query_test.go`) - -Tests for SQL query validation: -- **TestBillingMetricQuery**: Verifies query contains expected SQL keywords -- **TestBillingMetricQuery_TimeFilter**: Validates time filtering logic (7-day lookback) -- **TestBillingMetricQuery_Aggregation**: Tests AVG aggregation and GROUP BY clauses -- **TestBillingMetricQuery_SelectColumns**: Ensures all required columns are selected -- **TestBillingMetricQuery_ValidSQL**: Basic SQL syntax validation -- **TestBillingMetricQuery_TableReference**: Verifies correct table reference -- **TestBillingMetricQuery_TimeWindow**: Validates 7-day time window - -Total: 7 test cases - -## Test Philosophy - -The test suite focuses on: -1. **Configuration Validation**: Ensuring invalid configurations are caught early -2. **Metric Registration**: Verifying metrics are properly defined and registered -3. **Error Handling**: Testing failure scenarios (connection failures, invalid configs) -4. **SQL Query Integrity**: Validating the billing metrics query structure - -## Mocking - -The tests use dependency injection to mock database connections: -- The `Collector` struct's `openDatabase` function can be replaced for testing -- This allows testing collector behavior without actual Databricks credentials - -## Future Improvements - -Potential areas for expanded test coverage: -- Integration tests with a test Databricks workspace -- End-to-end tests for the HTTP server -- Performance/load testing for metric collection -- Tests for the main command-line interface diff --git a/cmd/databricks-exporter/main.go b/cmd/databricks-exporter/main.go index 127e7fb..e53b9b1 100644 --- a/cmd/databricks-exporter/main.go +++ b/cmd/databricks-exporter/main.go @@ -1,17 +1,3 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - package main import ( @@ -21,33 +7,47 @@ import ( "os" "github.com/alecthomas/kingpin/v2" - "github.com/go-kit/log" - "github.com/go-kit/log/level" "github.com/grafana/databricks-prometheus-exporter/collector" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" - "github.com/prometheus/common/promlog" - "github.com/prometheus/common/promlog/flag" + "github.com/prometheus/common/promslog" + "github.com/prometheus/common/promslog/flag" "github.com/prometheus/common/version" "github.com/prometheus/exporter-toolkit/web" webflag "github.com/prometheus/exporter-toolkit/web/kingpinflag" ) var ( - webConfig = webflag.AddFlags(kingpin.CommandLine, ":9976") - metricPath = kingpin.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").Envar("DATABRICKS_EXPORTER_WEB_TELEMETRY_PATH").String() - serverHostname = kingpin.Flag("server-hostname", "The Databricks workspace hostname (e.g., dbc-abc123-def456.cloud.databricks.com).").Envar("DATABRICKS_EXPORTER_SERVER_HOSTNAME").Required().String() - httpPath = kingpin.Flag("http-path", "The HTTP path of the SQL warehouse.").Envar("DATABRICKS_EXPORTER_HTTP_PATH").Required().String() - clientID = kingpin.Flag("client-id", "The OAuth2 Client ID (Application ID) for Service Principal authentication.").Envar("DATABRICKS_EXPORTER_CLIENT_ID").Required().String() - clientSecret = kingpin.Flag("client-secret", "The OAuth2 Client Secret for Service Principal authentication.").Envar("DATABRICKS_EXPORTER_CLIENT_SECRET").Required().String() - catalog = kingpin.Flag("catalog", "The catalog to use when querying.").Default("system").Envar("DATABRICKS_EXPORTER_CATALOG").String() - schema = kingpin.Flag("schema", "The schema to use when querying.").Default("billing").Envar("DATABRICKS_EXPORTER_SCHEMA").String() + webConfig = webflag.AddFlags(kingpin.CommandLine, ":9976") + metricPath = kingpin.Flag("web.telemetry-path", "Path under which to expose metrics.").Default("/metrics").Envar("DATABRICKS_EXPORTER_WEB_TELEMETRY_PATH").String() + serverHostname = kingpin.Flag("server-hostname", "The Databricks workspace hostname (e.g., dbc-abc123-def456.cloud.databricks.com).").Envar("DATABRICKS_EXPORTER_SERVER_HOSTNAME").Required().String() + warehouseHTTPPath = kingpin.Flag("warehouse-http-path", "The HTTP path of the SQL Warehouse (e.g., /sql/1.0/warehouses/abc123def456).").Envar("DATABRICKS_EXPORTER_WAREHOUSE_HTTP_PATH").Required().String() + clientID = kingpin.Flag("client-id", "The OAuth2 Client ID (Application ID) for Service Principal authentication.").Envar("DATABRICKS_EXPORTER_CLIENT_ID").Required().String() + clientSecret = kingpin.Flag("client-secret", "The OAuth2 Client Secret for Service Principal authentication.").Envar("DATABRICKS_EXPORTER_CLIENT_SECRET").Required().String() + + // Query settings + queryTimeout = kingpin.Flag("query-timeout", "Timeout for database queries.").Default("5m").Envar("DATABRICKS_EXPORTER_QUERY_TIMEOUT").Duration() + + // Lookback windows + billingLookback = kingpin.Flag("billing-lookback", "How far back to look for billing data.").Default("24h").Envar("DATABRICKS_EXPORTER_BILLING_LOOKBACK").Duration() + jobsLookback = kingpin.Flag("jobs-lookback", "How far back to look for job runs.").Default("3h").Envar("DATABRICKS_EXPORTER_JOBS_LOOKBACK").Duration() + pipelinesLookback = kingpin.Flag("pipelines-lookback", "How far back to look for pipeline runs.").Default("3h").Envar("DATABRICKS_EXPORTER_PIPELINES_LOOKBACK").Duration() + queriesLookback = kingpin.Flag("queries-lookback", "How far back to look for SQL warehouse queries.").Default("2h").Envar("DATABRICKS_EXPORTER_QUERIES_LOOKBACK").Duration() + + // SLA settings (default matches collector.DefaultSLAThresholdSeconds) + slaThreshold = kingpin.Flag("sla-threshold", "Duration threshold (in seconds) for job SLA miss detection.").Default("3600").Envar("DATABRICKS_EXPORTER_SLA_THRESHOLD").Int() + + // Cardinality controls + collectTaskRetries = kingpin.Flag("collect-task-retries", "Collect task retry metrics (high cardinality due to task_key label).").Default("false").Envar("DATABRICKS_EXPORTER_COLLECT_TASK_RETRIES").Bool() + + // Table availability settings + tableCheckInterval = kingpin.Flag("table-check-interval", "Number of scrapes between table availability checks (for optional tables like pipelines).").Default("10").Envar("DATABRICKS_EXPORTER_TABLE_CHECK_INTERVAL").Int() ) const ( // The name of the exporter. exporterName = "databricks_exporter" - landingPageHtml = ` + landingPageHTML = ` Databricks exporter

Databricks exporter

@@ -59,30 +59,47 @@ const ( func main() { kingpin.Version(version.Print(exporterName)) - promlogConfig := &promlog.Config{} + promslogConfig := &promslog.Config{} - flag.AddFlags(kingpin.CommandLine, promlogConfig) + flag.AddFlags(kingpin.CommandLine, promslogConfig) kingpin.HelpFlag.Short('h') kingpin.Parse() - logger := promlog.New(promlogConfig) + logger := promslog.New(promslogConfig) // Construct the collector, using the flags for configuration c := &collector.Config{ - ServerHostname: *serverHostname, - HTTPPath: *httpPath, - ClientID: *clientID, - ClientSecret: *clientSecret, - Catalog: *catalog, - Schema: *schema, + Version: version.Version, + ServerHostname: *serverHostname, + WarehouseHTTPPath: *warehouseHTTPPath, + ClientID: *clientID, + ClientSecret: *clientSecret, + QueryTimeout: *queryTimeout, + + // Lookback windows + BillingLookback: *billingLookback, + JobsLookback: *jobsLookback, + PipelinesLookback: *pipelinesLookback, + QueriesLookback: *queriesLookback, + + // SLA settings + SLAThresholdSeconds: *slaThreshold, + + // Cardinality controls + CollectTaskRetries: *collectTaskRetries, + + // Table availability settings + TableCheckInterval: *tableCheckInterval, } if err := c.Validate(); err != nil { - level.Error(logger).Log("msg", "Configuration is invalid.", "err", err) + logger.Error("Configuration is invalid.", "err", err) os.Exit(1) } - col := collector.NewCollector(logger, c) + // Add component prefix to logger for better log correlation + collectorLogger := logger.With("component", "databricks-exporter") + col := collector.NewCollector(collectorLogger, c) // Register collector with prometheus client library prometheus.MustRegister(col) @@ -90,19 +107,20 @@ func main() { serveMetrics(logger) } -func serveMetrics(logger log.Logger) { - landingPage := []byte(fmt.Sprintf(landingPageHtml, *metricPath)) +func serveMetrics(logger *slog.Logger) { + landingPage := []byte(fmt.Sprintf(landingPageHTML, *metricPath)) http.Handle(*metricPath, promhttp.Handler()) http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "text/html; charset=UTF-8") // nolint: errcheck - w.Write(landingPage) // nolint: errcheck + w.Header().Set("Content-Type", "text/html; charset=UTF-8") + if _, err := w.Write(landingPage); err != nil { + logger.Error("Failed to write landing page", "err", err) + } }) srv := &http.Server{} - slogger := slog.New(slog.NewTextHandler(os.Stderr, nil)) - if err := web.ListenAndServe(srv, webConfig, slogger); err != nil { - level.Error(logger).Log("msg", "Error running HTTP server", "err", err) + if err := web.ListenAndServe(srv, webConfig, logger); err != nil { + logger.Error("Error running HTTP server", "err", err) os.Exit(1) } } diff --git a/collector/billing.go b/collector/billing.go new file mode 100644 index 0000000..4bb1eb7 --- /dev/null +++ b/collector/billing.go @@ -0,0 +1,235 @@ +package collector + +import ( + "context" + "database/sql" + "fmt" + "log/slog" + "sync" + "sync/atomic" + "time" + + "github.com/prometheus/client_golang/prometheus" +) + +// BillingCollector collects billing and cost metrics from Databricks System Tables. +type BillingCollector struct { + db *sql.DB + metrics *MetricDescriptors + logger *slog.Logger + ctx context.Context + config *Config +} + +// NewBillingCollector creates a new billing metrics collector. +func NewBillingCollector(ctx context.Context, db *sql.DB, metrics *MetricDescriptors, config *Config, logger *slog.Logger) *BillingCollector { + return &BillingCollector{ + logger: logger, + db: db, + metrics: metrics, + ctx: ctx, + config: config, + } +} + +// Describe sends the descriptors of each metric over the provided channel. +func (c *BillingCollector) Describe(ch chan<- *prometheus.Desc) { + ch <- c.metrics.BillingDBUs + ch <- c.metrics.BillingCostEstimateUSD + ch <- c.metrics.PriceChangeEvents + ch <- c.metrics.BillingScrapeErrors + ch <- c.metrics.ScrapeStatus +} + +// Collect retrieves and emits all billing metrics. +// Queries run in parallel to reduce total scrape time (cost estimate query can take ~100s). +func (c *BillingCollector) Collect(ch chan<- prometheus.Metric) { + start := time.Now() + c.logger.Debug("Collecting billing metrics") + + var hasError atomic.Bool + var wg sync.WaitGroup + wg.Add(3) + + go func() { + defer wg.Done() + if err := c.collectBillingDBUs(ch); err != nil { + c.logger.Error("Failed to collect billing DBUs", "err", err) + c.emitError(ch, "billing_dbus") + hasError.Store(true) + } + }() + + go func() { + defer wg.Done() + if err := c.collectBillingCost(ch); err != nil { + c.logger.Error("Failed to collect billing cost estimates", "err", err) + c.emitError(ch, "billing_cost") + hasError.Store(true) + } + }() + + go func() { + defer wg.Done() + if err := c.collectPriceChangeEvents(ch); err != nil { + c.logger.Error("Failed to collect price change events", "err", err) + c.emitError(ch, "price_changes") + hasError.Store(true) + } + }() + + wg.Wait() + + // Emit scrape status + status := 1.0 + if hasError.Load() { + status = 0.0 + } + ch <- prometheus.MustNewConstMetric(c.metrics.ScrapeStatus, prometheus.GaugeValue, status, "billing") + + c.logger.Debug("Finished collecting billing metrics", "duration_seconds", time.Since(start).Seconds()) +} + +// collectBillingDBUs retrieves total DBU consumption per workspace and SKU. +func (c *BillingCollector) collectBillingDBUs(ch chan<- prometheus.Metric) error { + c.logger.Debug("Querying billing DBUs") + + lookback := c.config.BillingLookback + if lookback == 0 { + lookback = DefaultBillingLookback + } + query := BuildBillingDBUsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to query billing DBUs: %w", err) + } + defer rows.Close() + + count := 0 + for rows.Next() { + var workspaceID, skuName sql.NullString + var dbusTotal float64 + + if err := rows.Scan(&workspaceID, &skuName, &dbusTotal); err != nil { + c.logger.Error("Failed to scan billing DBUs row", "err", err) + continue + } + + // Skip rows with NULL workspace_id or sku_name (invalid data) + if !workspaceID.Valid || !skuName.Valid { + c.logger.Debug("Skipping billing DBU row with NULL workspace_id or sku_name") + continue + } + + ch <- prometheus.MustNewConstMetric( + c.metrics.BillingDBUs, + prometheus.GaugeValue, + dbusTotal, + workspaceID.String, + skuName.String, + ) + count++ + } + + c.logger.Debug("Collected billing DBUs", "count", count) + return rows.Err() +} + +// collectBillingCost retrieves total cost estimates by joining usage with prices. +func (c *BillingCollector) collectBillingCost(ch chan<- prometheus.Metric) error { + c.logger.Debug("Querying billing cost estimates") + + lookback := c.config.BillingLookback + if lookback == 0 { + lookback = DefaultBillingLookback + } + query := BuildBillingCostEstimateQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to query billing cost: %w", err) + } + defer rows.Close() + + count := 0 + for rows.Next() { + var workspaceID, skuName sql.NullString + var costEstimateUSD float64 + + if err := rows.Scan(&workspaceID, &skuName, &costEstimateUSD); err != nil { + c.logger.Error("Failed to scan billing cost row", "err", err) + continue + } + + // Skip rows with NULL workspace_id or sku_name (invalid data) + if !workspaceID.Valid || !skuName.Valid { + c.logger.Debug("Skipping billing cost row with NULL workspace_id or sku_name") + continue + } + + ch <- prometheus.MustNewConstMetric( + c.metrics.BillingCostEstimateUSD, + prometheus.GaugeValue, + costEstimateUSD, + workspaceID.String, + skuName.String, + ) + count++ + } + + c.logger.Debug("Collected billing cost estimates", "count", count) + return rows.Err() +} + +// collectPriceChangeEvents tracks price changes from the list_prices table. +func (c *BillingCollector) collectPriceChangeEvents(ch chan<- prometheus.Metric) error { + c.logger.Debug("Querying price change events") + + lookback := c.config.BillingLookback + if lookback == 0 { + lookback = DefaultBillingLookback + } + query := BuildPriceChangeEventsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to query price changes: %w", err) + } + defer rows.Close() + + count := 0 + for rows.Next() { + var skuName sql.NullString + var priceChangeCount float64 + + if err := rows.Scan(&skuName, &priceChangeCount); err != nil { + c.logger.Error("Failed to scan price change row", "err", err) + continue + } + + // Skip rows with NULL sku_name (invalid data) + if !skuName.Valid { + c.logger.Debug("Skipping price change row with NULL sku_name") + continue + } + + ch <- prometheus.MustNewConstMetric( + c.metrics.PriceChangeEvents, + prometheus.GaugeValue, + priceChangeCount, + skuName.String, + ) + count++ + } + + c.logger.Debug("Collected price change events", "count", count) + return rows.Err() +} + +// emitError emits a billing scrape error metric for the given stage. +func (c *BillingCollector) emitError(ch chan<- prometheus.Metric, stage string) { + ch <- prometheus.MustNewConstMetric( + c.metrics.BillingScrapeErrors, + prometheus.GaugeValue, + 1, + stage, + ) +} diff --git a/collector/billing_test.go b/collector/billing_test.go new file mode 100644 index 0000000..8adc514 --- /dev/null +++ b/collector/billing_test.go @@ -0,0 +1,354 @@ +package collector + +import ( + "context" + "database/sql" + "testing" + + "github.com/DATA-DOG/go-sqlmock" + "github.com/prometheus/client_golang/prometheus" + dto "github.com/prometheus/client_model/go" + "github.com/prometheus/common/promslog" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestBillingCollector_Initialization(t *testing.T) { + db, _, err := sqlmock.New() + require.NoError(t, err, "failed to create mock db") + defer db.Close() + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + require.NotNil(t, collector, "NewBillingCollector returned nil") + assert.Equal(t, db, collector.db, "db not set correctly") + assert.Equal(t, metrics, collector.metrics, "metrics not set correctly") +} + +func TestBillingCollector_CollectBillingDBUs(t *testing.T) { + db, mock, err := sqlmock.New() + require.NoError(t, err, "failed to create mock db") + defer db.Close() + + // Set up mock expectations + rows := sqlmock.NewRows([]string{"workspace_id", "sku_name", "dbus_total"}). + AddRow("87654321", "STANDARD_ALL_PURPOSE_COMPUTE", 125.5). + AddRow("87654321", "PREMIUM_JOBS_COMPUTE", 450.25). + AddRow("87654322", "STANDARD_ALL_PURPOSE_COMPUTE", 89.75) + + mock.ExpectQuery("SELECT (.+) FROM system.billing.usage"). + WillReturnRows(rows) + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Collect metrics + ch := make(chan prometheus.Metric, 10) + err = collector.collectBillingDBUs(ch) + close(ch) + + require.NoError(t, err, "collectBillingDBUs failed") + + // Verify metrics + count := 0 + for m := range ch { + count++ + + // Extract metric details + pb := &dto.Metric{} + require.NoError(t, m.Write(pb), "failed to write metric") + + // Verify it's a gauge + require.NotNil(t, pb.Gauge, "expected gauge metric") + + // Verify labels + labels := make(map[string]string) + for _, lp := range pb.Label { + labels[lp.GetName()] = lp.GetValue() + } + + assert.Contains(t, labels, "workspace_id", "missing workspace_id label") + assert.Contains(t, labels, "sku_name", "missing sku_name label") + + // Verify value + assert.Greater(t, pb.Gauge.GetValue(), float64(0), "expected positive value") + } + + assert.Equal(t, 3, count, "expected 3 metrics") + + // Verify all expectations were met + require.NoError(t, mock.ExpectationsWereMet(), "unfulfilled expectations") +} + +func TestBillingCollector_CollectBillingCost(t *testing.T) { + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Set up mock expectations + rows := sqlmock.NewRows([]string{"workspace_id", "sku_name", "cost_estimate_usd"}). + AddRow("87654321", "STANDARD_ALL_PURPOSE_COMPUTE", 69.025). + AddRow("87654321", "PREMIUM_JOBS_COMPUTE", 337.6875) + + mock.ExpectQuery("SELECT (.+) FROM system.billing.usage u"). + WillReturnRows(rows) + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Collect metrics + ch := make(chan prometheus.Metric, 10) + err = collector.collectBillingCost(ch) + close(ch) + + if err != nil { + t.Fatalf("collectBillingCost failed: %v", err) + } + + // Verify metrics + count := 0 + for m := range ch { + count++ + + pb := &dto.Metric{} + if err := m.Write(pb); err != nil { + t.Fatalf("failed to write metric: %v", err) + } + + if pb.Gauge == nil { + t.Error("expected gauge metric") + continue + } + + // Verify value is positive (cost estimate) + if pb.Gauge.GetValue() <= 0 { + t.Errorf("expected positive cost, got %f", pb.Gauge.GetValue()) + } + } + + if count != 2 { + t.Errorf("expected 2 metrics, got %d", count) + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestBillingCollector_CollectPriceChangeEvents(t *testing.T) { + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Set up mock expectations + rows := sqlmock.NewRows([]string{"sku_name", "price_change_count"}). + AddRow("STANDARD_ALL_PURPOSE_COMPUTE", 2.0). + AddRow("PREMIUM_JOBS_COMPUTE", 2.0) + + mock.ExpectQuery("SELECT (.+) FROM system.billing.list_prices"). + WillReturnRows(rows) + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Collect metrics + ch := make(chan prometheus.Metric, 10) + err = collector.collectPriceChangeEvents(ch) + close(ch) + + if err != nil { + t.Fatalf("collectPriceChangeEvents failed: %v", err) + } + + // Verify metrics + count := 0 + for m := range ch { + count++ + + pb := &dto.Metric{} + if err := m.Write(pb); err != nil { + t.Fatalf("failed to write metric: %v", err) + } + + // Verify it's a gauge (sliding window metric) + if pb.Gauge == nil { + t.Error("expected gauge metric") + continue + } + + // Verify labels + labels := make(map[string]string) + for _, lp := range pb.Label { + labels[lp.GetName()] = lp.GetValue() + } + + if _, ok := labels["sku_name"]; !ok { + t.Error("missing sku_name label") + } + } + + if count != 2 { + t.Errorf("expected 2 metrics, got %d", count) + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestBillingCollector_CollectWithError(t *testing.T) { + db, mock, err := sqlmock.New() + require.NoError(t, err, "failed to create mock db") + defer db.Close() + + // Simulate query error + mock.ExpectQuery("SELECT (.+) FROM system.billing.usage"). + WillReturnError(sql.ErrConnDone) + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Collect metrics + ch := make(chan prometheus.Metric, 10) + err = collector.collectBillingDBUs(ch) + close(ch) + + require.Error(t, err, "expected error, got nil") + + // Verify no metrics were emitted + count := 0 + for range ch { + count++ + } + + assert.Equal(t, 0, count, "expected 0 metrics on error") +} + +func TestBillingCollector_CollectEmitsErrorMetric(t *testing.T) { + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Test error emission + ch := make(chan prometheus.Metric, 1) + collector.emitError(ch, "test_stage") + close(ch) + + count := 0 + for m := range ch { + count++ + + pb := &dto.Metric{} + if err := m.Write(pb); err != nil { + t.Fatalf("failed to write metric: %v", err) + } + + // Verify it's a gauge (error indicator for this scrape cycle) + if pb.Gauge == nil { + t.Error("expected gauge metric") + continue + } + + // Verify stage label + labels := make(map[string]string) + for _, lp := range pb.Label { + labels[lp.GetName()] = lp.GetValue() + } + + if stage, ok := labels["stage"]; !ok { + t.Error("missing stage label") + } else if stage != "test_stage" { + t.Errorf("expected stage=test_stage, got stage=%s", stage) + } + + // Verify value is 1 + if pb.Gauge.GetValue() != 1 { + t.Errorf("expected error value of 1, got %f", pb.Gauge.GetValue()) + } + } + + if count != 1 { + t.Errorf("expected 1 error metric, got %d", count) + } +} + +func TestBillingCollector_CollectContinuesOnPartialFailure(t *testing.T) { + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // First query fails + mock.ExpectQuery("SELECT (.+) FROM system.billing.usage"). + WillReturnError(sql.ErrConnDone) + + // Second query succeeds + costRows := sqlmock.NewRows([]string{"workspace_id", "sku_name", "cost_estimate_usd"}). + AddRow("87654321", "STANDARD_ALL_PURPOSE_COMPUTE", 69.025) + mock.ExpectQuery("SELECT (.+) FROM system.billing.usage u"). + WillReturnRows(costRows) + + // Third query succeeds + priceRows := sqlmock.NewRows([]string{"sku_name", "price_change_count"}). + AddRow("STANDARD_ALL_PURPOSE_COMPUTE", 2.0) + mock.ExpectQuery("SELECT (.+) FROM system.billing.list_prices"). + WillReturnRows(priceRows) + + metrics := NewMetricDescriptors() + logger := promslog.NewNopLogger() + collector := NewBillingCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Collect all metrics - should continue despite first failure + ch := make(chan prometheus.Metric, 20) + collector.Collect(ch) + close(ch) + + // Count metrics (should have cost + price + error metrics) + count := 0 + errorCount := 0 + for m := range ch { + count++ + + pb := &dto.Metric{} + if err := m.Write(pb); err != nil { + continue + } + + // Check for error metrics + labels := make(map[string]string) + for _, lp := range pb.Label { + labels[lp.GetName()] = lp.GetValue() + } + + if _, ok := labels["stage"]; ok { + errorCount++ + } + } + + // Should have at least 2 data metrics + 1 error metric + if count < 3 { + t.Errorf("expected at least 3 metrics (2 data + 1 error), got %d", count) + } + + if errorCount == 0 { + t.Error("expected at least one error metric") + } +} diff --git a/collector/collector.go b/collector/collector.go index c5d4c37..9c60675 100644 --- a/collector/collector.go +++ b/collector/collector.go @@ -1,38 +1,38 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - package collector import ( + "context" "database/sql" "fmt" + "log/slog" + "sync" + "time" dbsql "github.com/databricks/databricks-sql-go" "github.com/databricks/databricks-sql-go/auth/oauth/m2m" - "github.com/go-kit/log" - "github.com/go-kit/log/level" "github.com/prometheus/client_golang/prometheus" ) const ( namespace = "databricks" - labelAccountID = "account_id" + // Common labels used in metrics labelWorkspaceID = "workspace_id" labelSKUName = "sku_name" - labelCloud = "cloud" - labelUsageUnit = "usage_unit" + labelStatus = "status" + labelStage = "stage" + labelQuantile = "quantile" + + // Resource identification labels + labelJobID = "job_id" + labelJobName = "job_name" + labelPipelineID = "pipeline_id" + labelPipelineName = "pipeline_name" + labelTaskKey = "task_key" + labelWarehouseID = "warehouse_id" + + // Scrape status labels + labelQuery = "query" ) // openDatabricksDatabase opens a connection to a Databricks SQL Warehouse using OAuth2 M2M authentication. @@ -47,115 +47,153 @@ func openDatabricksDatabase(config *Config) (*sql.DB, error) { // Create connector with OAuth authentication connector, err := dbsql.NewConnector( dbsql.WithServerHostname(config.ServerHostname), - dbsql.WithHTTPPath(config.HTTPPath), + dbsql.WithHTTPPath(config.WarehouseHTTPPath), dbsql.WithPort(443), dbsql.WithAuthenticator(authenticator), - dbsql.WithInitialNamespace(config.Catalog, config.Schema), ) if err != nil { return nil, fmt.Errorf("failed to create connector: %w", err) } - return sql.OpenDB(connector), nil + db := sql.OpenDB(connector) + + // Configure connection pool for better resilience + db.SetMaxOpenConns(10) // Limit concurrent connections to avoid overwhelming Databricks + db.SetMaxIdleConns(5) // Keep some connections warm + db.SetConnMaxLifetime(5 * time.Minute) // Recycle connections every 5 minutes + db.SetConnMaxIdleTime(1 * time.Minute) // Close idle connections after 1 minute + + return db, nil } -// Collector is a prometheus.Collector that retrieves billing and usage metrics for a Databricks account. +// Collector is a prometheus.Collector that retrieves all metrics for a Databricks account. +// It orchestrates multiple specialized collectors for different metric categories. type Collector struct { - config *Config - logger log.Logger - // For mocking - openDatabase func(*Config) (*sql.DB, error) - - usageQuantity *prometheus.Desc - up *prometheus.Desc + config *Config + logger *slog.Logger + openDatabase func(*Config) (*sql.DB, error) // For mocking + metrics *MetricDescriptors + + // Persistent connection pool - reused across scrapes + db *sql.DB + dbMu sync.RWMutex } // NewCollector creates a new collector from a given config. // The config is assumed to be valid. -func NewCollector(logger log.Logger, c *Config) *Collector { +func NewCollector(logger *slog.Logger, c *Config) *Collector { + metrics := NewMetricDescriptors() + return &Collector{ config: c, logger: logger, openDatabase: openDatabricksDatabase, - usageQuantity: prometheus.NewDesc( - prometheus.BuildFQName(namespace, "billing", "usage_quantity"), - "Usage quantity information from system.billing.usage table, aggregated over the last 7 days.", - []string{labelAccountID, labelWorkspaceID, labelSKUName, labelCloud, labelUsageUnit}, - nil, - ), - up: prometheus.NewDesc( - prometheus.BuildFQName(namespace, "", "up"), - "Metric indicating the status of the exporter collection. 1 indicates that the connection to Databricks was successful, and all available metrics were collected. "+ - "0 indicates that the exporter failed to collect 1 or more metrics, due to an inability to connect to Databricks.", - nil, - nil, - ), + metrics: metrics, } } -// Describe returns all metric descriptions of the collector by emitting them down the provided channel. -// It implements prometheus.Collector. +// getDB returns a healthy database connection, creating one if needed. +// It tests the connection with Ping() and recreates if unhealthy. +func (c *Collector) getDB() (*sql.DB, error) { + c.dbMu.RLock() + db := c.db + c.dbMu.RUnlock() + + // Test existing connection + if db != nil { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + if err := db.PingContext(ctx); err == nil { + return db, nil + } + c.logger.Warn("Existing connection unhealthy, reconnecting", "err", "ping failed") + } + + // Need to create or recreate connection + c.dbMu.Lock() + defer c.dbMu.Unlock() + + // Double-check after acquiring write lock + if c.db != nil { + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + if err := c.db.PingContext(ctx); err == nil { + return c.db, nil + } + // Close unhealthy connection + c.db.Close() + c.db = nil + } + + // Create new connection + db, err := c.openDatabase(c.config) + if err != nil { + return nil, err + } + + c.db = db + c.logger.Debug("Created new database connection pool") + return db, nil +} + +// Describe implements prometheus.Collector. func (c *Collector) Describe(descs chan<- *prometheus.Desc) { - descs <- c.usageQuantity - descs <- c.up + c.metrics.Describe(descs) } // Collect collects all metrics for this collector, and emits them through the provided channel. // It implements prometheus.Collector. func (c *Collector) Collect(metrics chan<- prometheus.Metric) { - level.Debug(c.logger).Log("msg", "Collecting metrics.") + c.logger.Debug("Collecting metrics.") - var up float64 = 1 - // Open a new connection to the database each time; This makes the connection more robust to transient failures - db, err := c.openDatabase(c.config) + // Get a healthy connection from the pool (creates one if needed) + db, err := c.getDB() if err != nil { - level.Error(c.logger).Log("msg", "Failed to connect to Databricks.", "err", err) - // Emit up metric here, to indicate connection failed. - metrics <- prometheus.MustNewConstMetric(c.up, prometheus.GaugeValue, 0) + c.logger.Error("Failed to connect to Databricks.", "err", err) + metrics <- prometheus.MustNewConstMetric(c.metrics.ExporterUp, prometheus.GaugeValue, 0) return } - defer db.Close() + // Don't close - connection is reused across scrapes + + // Emit up=1 early so it's always reported even if collection hangs + metrics <- prometheus.MustNewConstMetric(c.metrics.ExporterUp, prometheus.GaugeValue, 1) + c.logger.Debug("Database connection healthy, emitted up=1") + + // Emit exporter info metric with version and window configuration + metrics <- prometheus.MustNewConstMetric( + c.metrics.ExporterInfo, + prometheus.GaugeValue, + 1, + c.config.Version, + c.config.BillingLookback.String(), + c.config.JobsLookback.String(), + c.config.PipelinesLookback.String(), + c.config.QueriesLookback.String(), + ) - if err := c.collectBillingMetrics(db, metrics); err != nil { - level.Error(c.logger).Log("msg", "Failed to collect billing metrics.", "err", err) - up = 0 + queryTimeout := c.config.QueryTimeout + if queryTimeout == 0 { + queryTimeout = DefaultQueryTimeout } - metrics <- prometheus.MustNewConstMetric(c.up, prometheus.GaugeValue, up) - level.Debug(c.logger).Log("msg", "Finished collecting metrics.") -} + ctx, cancel := context.WithTimeout(context.Background(), queryTimeout) + defer cancel() -func (c *Collector) collectBillingMetrics(db *sql.DB, metrics chan<- prometheus.Metric) error { - level.Debug(c.logger).Log("msg", "Collecting billing metrics.") - rows, err := db.Query(billingMetricQuery) - level.Debug(c.logger).Log("msg", "Done querying billing metrics.") - if err != nil { - return fmt.Errorf("failed to query metrics: %w", err) - } - defer rows.Close() + billingCollector := NewBillingCollector(ctx, db, c.metrics, c.config, c.logger) + jobsCollector := NewJobsCollector(ctx, db, c.metrics, c.config, c.logger) + pipelinesCollector := NewPipelinesCollector(ctx, db, c.metrics, c.config, c.logger) + sqlWarehouseCollector := NewSQLWarehouseCollector(ctx, db, c.metrics, c.config, c.logger) - for rows.Next() { - var accountID, workspaceID, skuName, cloud, usageUnit sql.NullString - var usageQuantity sql.NullFloat64 + start := time.Now() - if err := rows.Scan(&accountID, &workspaceID, &skuName, &cloud, &usageUnit, &usageQuantity); err != nil { - return fmt.Errorf("failed to scan row: %w", err) - } - - if usageQuantity.Valid { - metrics <- prometheus.MustNewConstMetric( - c.usageQuantity, - prometheus.GaugeValue, - usageQuantity.Float64, - accountID.String, - workspaceID.String, - skuName.String, - cloud.String, - usageUnit.String, - ) - } - } + // Run collectors in parallel to reduce total scrape time + var wg sync.WaitGroup + wg.Add(4) + go func() { defer wg.Done(); billingCollector.Collect(metrics) }() + go func() { defer wg.Done(); jobsCollector.Collect(metrics) }() + go func() { defer wg.Done(); pipelinesCollector.Collect(metrics) }() + go func() { defer wg.Done(); sqlWarehouseCollector.Collect(metrics) }() + wg.Wait() - level.Debug(c.logger).Log("msg", "Finished collecting billing metrics.") - return rows.Err() + c.logger.Debug("Finished collecting metrics", "duration_seconds", time.Since(start).Seconds()) } diff --git a/collector/collector_test.go b/collector/collector_test.go index 5a2107d..2a3f8fc 100644 --- a/collector/collector_test.go +++ b/collector/collector_test.go @@ -1,62 +1,21 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - package collector import ( "database/sql" - "database/sql/driver" "errors" "testing" - "github.com/go-kit/log" "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/common/promslog" ) -// mockDB is a mock database implementation for testing -type mockRows struct { - data [][]driver.Value - columns []string - pos int -} - -func (m *mockRows) Columns() []string { - return m.columns -} - -func (m *mockRows) Close() error { - return nil -} - -func (m *mockRows) Next(dest []driver.Value) error { - if m.pos >= len(m.data) { - return sql.ErrNoRows - } - copy(dest, m.data[m.pos]) - m.pos++ - return nil -} - func TestNewCollector(t *testing.T) { - logger := log.NewNopLogger() + logger := promslog.NewNopLogger() config := &Config{ - ServerHostname: "test.databricks.com", - HTTPPath: "/sql/1.0/warehouses/test", - ClientID: "test-id", - ClientSecret: "test-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "test.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/test", + ClientID: "test-id", + ClientSecret: "test-secret", } collector := NewCollector(logger, config) @@ -77,24 +36,18 @@ func TestNewCollector(t *testing.T) { t.Error("collector openDatabase function should not be nil") } - if collector.accountPrices == nil { - t.Error("collector accountPrices metric descriptor should not be nil") - } - - if collector.up == nil { - t.Error("collector up metric descriptor should not be nil") + if collector.metrics == nil { + t.Error("collector metrics should not be nil") } } func TestCollectorDescribe(t *testing.T) { - logger := log.NewNopLogger() + logger := promslog.NewNopLogger() config := &Config{ - ServerHostname: "test.databricks.com", - HTTPPath: "/sql/1.0/warehouses/test", - ClientID: "test-id", - ClientSecret: "test-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "test.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/test", + ClientID: "test-id", + ClientSecret: "test-secret", } collector := NewCollector(logger, config) @@ -110,20 +63,20 @@ func TestCollectorDescribe(t *testing.T) { descriptions = append(descriptions, desc) } - if len(descriptions) != 2 { - t.Errorf("expected 2 metric descriptions, got %d", len(descriptions)) + // Should have all metrics + expectedCount := 21 + if len(descriptions) != expectedCount { + t.Errorf("expected %d metric descriptions, got %d", expectedCount, len(descriptions)) } } func TestCollectorCollect_DatabaseConnectionFailure(t *testing.T) { - logger := log.NewNopLogger() + logger := promslog.NewNopLogger() config := &Config{ - ServerHostname: "test.databricks.com", - HTTPPath: "/sql/1.0/warehouses/test", - ClientID: "test-id", - ClientSecret: "test-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "test.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/test", + ClientID: "test-id", + ClientSecret: "test-secret", } collector := NewCollector(logger, config) @@ -142,11 +95,11 @@ func TestCollectorCollect_DatabaseConnectionFailure(t *testing.T) { t.Fatalf("failed to gather metrics: %v", err) } - // Find the up metric + // Find the exporter_up metric var upValue float64 found := false for _, mf := range metricFamilies { - if *mf.Name == "databricks_up" { + if *mf.Name == "databricks_exporter_up" { if len(mf.Metric) > 0 { upValue = *mf.Metric[0].Gauge.Value found = true @@ -156,23 +109,21 @@ func TestCollectorCollect_DatabaseConnectionFailure(t *testing.T) { } if !found { - t.Fatal("up metric not found") + t.Fatal("exporter_up metric not found") } if upValue != 0 { - t.Errorf("expected up metric to be 0, got %f", upValue) + t.Errorf("expected exporter_up metric to be 0, got %f", upValue) } } func TestCollectorMetricNames(t *testing.T) { - logger := log.NewNopLogger() + logger := promslog.NewNopLogger() config := &Config{ - ServerHostname: "test.databricks.com", - HTTPPath: "/sql/1.0/warehouses/test", - ClientID: "test-id", - ClientSecret: "test-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "test.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/test", + ClientID: "test-id", + ClientSecret: "test-secret", } collector := NewCollector(logger, config) @@ -183,7 +134,7 @@ func TestCollectorMetricNames(t *testing.T) { } // Check that metric descriptors have correct names - expectedUpName := "databricks_up" + expectedUpName := "databricks_exporter_up" // Create a temporary registry to extract metric info registry := prometheus.NewRegistry() @@ -210,57 +161,15 @@ func TestCollectorMetricNames(t *testing.T) { // Since we're mocking a connection failure, we only expect the 'up' metric } -func TestCollectorLabels(t *testing.T) { - expectedLabels := []string{ - labelAccountID, - labelSKUName, - labelCloud, - labelCurrencyCode, - labelUsageUnit, - } - - // Verify labels are correctly defined - for _, label := range expectedLabels { - if label == "" { - t.Errorf("label should not be empty") - } - } - - // Verify expected label values - if labelAccountID != "account_id" { - t.Errorf("expected labelAccountID to be 'account_id', got '%s'", labelAccountID) - } - if labelSKUName != "sku_name" { - t.Errorf("expected labelSKUName to be 'sku_name', got '%s'", labelSKUName) - } - if labelCloud != "cloud" { - t.Errorf("expected labelCloud to be 'cloud', got '%s'", labelCloud) - } - if labelCurrencyCode != "currency_code" { - t.Errorf("expected labelCurrencyCode to be 'currency_code', got '%s'", labelCurrencyCode) - } - if labelUsageUnit != "usage_unit" { - t.Errorf("expected labelUsageUnit to be 'usage_unit', got '%s'", labelUsageUnit) - } -} - -func TestNamespaceConstant(t *testing.T) { - if namespace != "databricks" { - t.Errorf("expected namespace to be 'databricks', got '%s'", namespace) - } -} - func TestOpenDatabricksDatabase_ValidatesConnection(t *testing.T) { // Test that openDatabricksDatabase creates a connector // We can't test actual connection without valid credentials, // but we can verify the function signature and basic behavior config := &Config{ - ServerHostname: "test.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/test123", - ClientID: "test-client-id", - ClientSecret: "test-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "test.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/test123", + ClientID: "test-client-id", + ClientSecret: "test-secret", } // This will attempt to create a connector but should return without error diff --git a/collector/config.go b/collector/config.go index 8582c5e..8502024 100644 --- a/collector/config.go +++ b/collector/config.go @@ -1,48 +1,89 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - package collector import ( "errors" + "time" +) + +// Time constants +const ( + SecondsPerHour = 60 * 60 // 3600 seconds ) +// Default values for configuration options. +// +// Lookback windows are sized to prevent data loss with scrape intervals up to 30 minutes. +// Formula: lookback >= scrape_interval + max_data_lag + buffer +const ( + DefaultQueryTimeout = 5 * time.Minute + DefaultBillingLookback = 24 * time.Hour // Daily aggregation, 24-48h data lag + DefaultJobsLookback = 3 * time.Hour // 1-5 min data lag, 30min scrape buffer + DefaultPipelinesLookback = 3 * time.Hour // 1-5 min data lag, 30min scrape buffer + DefaultQueriesLookback = 2 * time.Hour // 5-15 min data lag, 30min scrape buffer + DefaultSLAThresholdSeconds = SecondsPerHour + DefaultTableCheckInterval = 10 // Number of scrapes between table availability checks +) + +// Config holds the configuration for the Databricks exporter. type Config struct { - ServerHostname string - HTTPPath string - ClientID string - ClientSecret string - Catalog string - Schema string + // Exporter metadata + Version string // Exporter version for info metric + + // Connection settings + ServerHostname string + WarehouseHTTPPath string + ClientID string + ClientSecret string + + // Query settings + QueryTimeout time.Duration // Timeout for individual database queries + + // Lookback windows for different metric domains + BillingLookback time.Duration // How far back to look for billing data + JobsLookback time.Duration // How far back to look for job runs + PipelinesLookback time.Duration // How far back to look for pipeline runs + QueriesLookback time.Duration // How far back to look for SQL warehouse queries + + // SLA settings + SLAThresholdSeconds int // Duration threshold (in seconds) for SLA miss detection + + // Cardinality controls + CollectTaskRetries bool // Collect task retry metrics (high cardinality due to task_key) + + // Table availability settings + TableCheckInterval int // Number of scrapes between table availability checks (for optional tables like pipelines) } var ( - errNoServerHostname = errors.New("server_hostname must be specified") - errNoHTTPPath = errors.New("http_path must be specified") - errNoClientID = errors.New("client_id must be specified") - errNoClientSecret = errors.New("client_secret must be specified") - errNoCatalog = errors.New("catalog must be specified") - errNoSchema = errors.New("schema must be specified") + errNoServerHostname = errors.New("server_hostname must be specified") + errNoWarehouseHTTPPath = errors.New("warehouse_http_path must be specified") + errNoClientID = errors.New("client_id must be specified") + errNoClientSecret = errors.New("client_secret must be specified") ) +// DefaultConfig returns a Config with all default values set. +// Useful for tests that don't need specific config values. +func DefaultConfig() *Config { + return &Config{ + Version: "unknown", // Set by main.go from build info + QueryTimeout: DefaultQueryTimeout, + BillingLookback: DefaultBillingLookback, + JobsLookback: DefaultJobsLookback, + PipelinesLookback: DefaultPipelinesLookback, + QueriesLookback: DefaultQueriesLookback, + SLAThresholdSeconds: DefaultSLAThresholdSeconds, + CollectTaskRetries: false, + TableCheckInterval: DefaultTableCheckInterval, + } +} + func (c Config) Validate() error { if c.ServerHostname == "" { return errNoServerHostname } - if c.HTTPPath == "" { - return errNoHTTPPath + if c.WarehouseHTTPPath == "" { + return errNoWarehouseHTTPPath } if c.ClientID == "" { @@ -53,13 +94,5 @@ func (c Config) Validate() error { return errNoClientSecret } - if c.Catalog == "" { - return errNoCatalog - } - - if c.Schema == "" { - return errNoSchema - } - return nil } diff --git a/collector/config_test.go b/collector/config_test.go index 04cd827..f3773dd 100644 --- a/collector/config_test.go +++ b/collector/config_test.go @@ -1,17 +1,3 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - package collector import ( @@ -28,47 +14,39 @@ func TestConfigValidate(t *testing.T) { { name: "valid configuration", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "test-client-id", + ClientSecret: "test-client-secret", }, expectError: false, }, { name: "missing server hostname", config: Config{ - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "test-client-id", + ClientSecret: "test-client-secret", }, expectError: true, expectedErr: errNoServerHostname, }, { - name: "missing http path", + name: "missing warehouse http path", config: Config{ ServerHostname: "dbc-abc123-def456.cloud.databricks.com", ClientID: "test-client-id", ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", }, expectError: true, - expectedErr: errNoHTTPPath, + expectedErr: errNoWarehouseHTTPPath, }, { name: "missing client id", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientSecret: "test-client-secret", }, expectError: true, expectedErr: errNoClientID, @@ -76,74 +54,42 @@ func TestConfigValidate(t *testing.T) { { name: "missing client secret", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "test-client-id", }, expectError: true, expectedErr: errNoClientSecret, }, - { - name: "missing catalog", - config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Schema: "billing", - }, - expectError: true, - expectedErr: errNoCatalog, - }, - { - name: "missing schema", - config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Catalog: "system", - }, - expectError: true, - expectedErr: errNoSchema, - }, { name: "empty server hostname", config: Config{ - ServerHostname: "", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "test-client-id", + ClientSecret: "test-client-secret", }, expectError: true, expectedErr: errNoServerHostname, }, { - name: "empty http path", + name: "empty warehouse http path", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "", - ClientID: "test-client-id", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "", + ClientID: "test-client-id", + ClientSecret: "test-client-secret", }, expectError: true, - expectedErr: errNoHTTPPath, + expectedErr: errNoWarehouseHTTPPath, }, { name: "empty client id", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "", - ClientSecret: "test-client-secret", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "", + ClientSecret: "test-client-secret", }, expectError: true, expectedErr: errNoClientID, @@ -151,12 +97,10 @@ func TestConfigValidate(t *testing.T) { { name: "empty client secret", config: Config{ - ServerHostname: "dbc-abc123-def456.cloud.databricks.com", - HTTPPath: "/sql/1.0/warehouses/abc123", - ClientID: "test-client-id", - ClientSecret: "", - Catalog: "system", - Schema: "billing", + ServerHostname: "dbc-abc123-def456.cloud.databricks.com", + WarehouseHTTPPath: "/sql/1.0/warehouses/abc123", + ClientID: "test-client-id", + ClientSecret: "", }, expectError: true, expectedErr: errNoClientSecret, @@ -164,12 +108,10 @@ func TestConfigValidate(t *testing.T) { { name: "all fields empty", config: Config{ - ServerHostname: "", - HTTPPath: "", - ClientID: "", - ClientSecret: "", - Catalog: "", - Schema: "", + ServerHostname: "", + WarehouseHTTPPath: "", + ClientID: "", + ClientSecret: "", }, expectError: true, expectedErr: errNoServerHostname, @@ -208,11 +150,11 @@ func TestConfigValidationOrder(t *testing.T) { config.ServerHostname = "test.databricks.com" err = config.Validate() - if err != errNoHTTPPath { - t.Errorf("expected second validation error to be errNoHTTPPath, got %v", err) + if err != errNoWarehouseHTTPPath { + t.Errorf("expected second validation error to be errNoWarehouseHTTPPath, got %v", err) } - config.HTTPPath = "/sql/1.0/warehouses/test" + config.WarehouseHTTPPath = "/sql/1.0/warehouses/test" err = config.Validate() if err != errNoClientID { t.Errorf("expected third validation error to be errNoClientID, got %v", err) @@ -226,18 +168,6 @@ func TestConfigValidationOrder(t *testing.T) { config.ClientSecret = "test-secret" err = config.Validate() - if err != errNoCatalog { - t.Errorf("expected fifth validation error to be errNoCatalog, got %v", err) - } - - config.Catalog = "system" - err = config.Validate() - if err != errNoSchema { - t.Errorf("expected sixth validation error to be errNoSchema, got %v", err) - } - - config.Schema = "billing" - err = config.Validate() if err != nil { t.Errorf("expected no error after all fields set, got %v", err) } diff --git a/collector/jobs.go b/collector/jobs.go new file mode 100644 index 0000000..867c319 --- /dev/null +++ b/collector/jobs.go @@ -0,0 +1,298 @@ +package collector + +import ( + "context" + "database/sql" + "fmt" + "log/slog" + "time" + + "github.com/prometheus/client_golang/prometheus" +) + +// JobsCollector collects job-related metrics from Databricks. +type JobsCollector struct { + logger *slog.Logger + db *sql.DB + ctx context.Context + config *Config + + metrics *MetricDescriptors +} + +// NewJobsCollector creates a new JobsCollector. +func NewJobsCollector(ctx context.Context, db *sql.DB, metrics *MetricDescriptors, config *Config, logger *slog.Logger) *JobsCollector { + return &JobsCollector{ + logger: logger, + db: db, + metrics: metrics, + ctx: ctx, + config: config, + } +} + +// Describe sends the descriptors of each metric over the provided channel. +func (c *JobsCollector) Describe(ch chan<- *prometheus.Desc) { + ch <- c.metrics.JobRuns + ch <- c.metrics.JobRunStatus + ch <- c.metrics.JobRunDurationSeconds + ch <- c.metrics.TaskRetries + ch <- c.metrics.JobSLAMiss + ch <- c.metrics.ScrapeStatus +} + +// Collect fetches metrics from Databricks and sends them to Prometheus. +func (c *JobsCollector) Collect(ch chan<- prometheus.Metric) { + start := time.Now() + c.logger.Debug("Collecting job metrics") + + var hasError bool + + if err := c.collectJobRuns(ch); err != nil { + c.logger.Error("Failed to collect job runs", "err", err) + hasError = true + } + + if err := c.collectJobRunStatus(ch); err != nil { + c.logger.Error("Failed to collect job run status", "err", err) + hasError = true + } + + if err := c.collectJobRunDuration(ch); err != nil { + c.logger.Error("Failed to collect job run duration", "err", err) + hasError = true + } + + if err := c.collectTaskRetries(ch); err != nil { + c.logger.Error("Failed to collect task retries", "err", err) + hasError = true + } + + if err := c.collectJobSLAMiss(ch); err != nil { + c.logger.Error("Failed to collect job SLA misses", "err", err) + hasError = true + } + + // Emit scrape status + status := 1.0 + if hasError { + status = 0.0 + } + ch <- prometheus.MustNewConstMetric(c.metrics.ScrapeStatus, prometheus.GaugeValue, status, "jobs") + + c.logger.Debug("Finished collecting job metrics", "duration_seconds", time.Since(start).Seconds()) +} + +// collectJobRuns collects the total number of job runs per job. +func (c *JobsCollector) collectJobRuns(ch chan<- prometheus.Metric) error { + lookback := c.config.JobsLookback + if lookback == 0 { + lookback = DefaultJobsLookback + } + query := BuildJobRunsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute job runs query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, jobID, jobName sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &jobID, &jobName, &count); err != nil { + return fmt.Errorf("failed to scan job runs row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobRuns, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + jobID.String, + jobName.String, + ) + } + } + + return rows.Err() +} + +// collectJobRunStatus collects job run counts by status per job. +func (c *JobsCollector) collectJobRunStatus(ch chan<- prometheus.Metric) error { + lookback := c.config.JobsLookback + if lookback == 0 { + lookback = DefaultJobsLookback + } + query := BuildJobRunStatusQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute job run status query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, jobID, jobName, status sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &jobID, &jobName, &status, &count); err != nil { + return fmt.Errorf("failed to scan job run status row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobRunStatus, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + jobID.String, + jobName.String, + status.String, + ) + } + } + + return rows.Err() +} + +// collectJobRunDuration collects job run duration quantiles per job. +func (c *JobsCollector) collectJobRunDuration(ch chan<- prometheus.Metric) error { + lookback := c.config.JobsLookback + if lookback == 0 { + lookback = DefaultJobsLookback + } + query := BuildJobRunDurationQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute job run duration query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, jobID, jobName sql.NullString + var p50, p95, p99 sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &jobID, &jobName, &p50, &p95, &p99); err != nil { + return fmt.Errorf("failed to scan job run duration row: %w", err) + } + + if p50.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobRunDurationSeconds, + prometheus.GaugeValue, + p50.Float64, + workspaceID.String, + jobID.String, + jobName.String, + "0.50", + ) + } + if p95.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobRunDurationSeconds, + prometheus.GaugeValue, + p95.Float64, + workspaceID.String, + jobID.String, + jobName.String, + "0.95", + ) + } + if p99.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobRunDurationSeconds, + prometheus.GaugeValue, + p99.Float64, + workspaceID.String, + jobID.String, + jobName.String, + "0.99", + ) + } + } + + return rows.Err() +} + +// collectTaskRetries collects the total number of task retries per job and task. +func (c *JobsCollector) collectTaskRetries(ch chan<- prometheus.Metric) error { + // Skip task retries if disabled (high cardinality due to task_key label) + if !c.config.CollectTaskRetries { + return nil + } + + lookback := c.config.JobsLookback + if lookback == 0 { + lookback = DefaultJobsLookback + } + query := BuildTaskRetriesQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute task retries query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, jobID, jobName, taskKey sql.NullString + var retries sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &jobID, &jobName, &taskKey, &retries); err != nil { + return fmt.Errorf("failed to scan task retries row: %w", err) + } + + if retries.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.TaskRetries, + prometheus.GaugeValue, + retries.Float64, + workspaceID.String, + jobID.String, + jobName.String, + taskKey.String, + ) + } + } + + return rows.Err() +} + +// collectJobSLAMiss collects the number of jobs that missed their SLA per job. +func (c *JobsCollector) collectJobSLAMiss(ch chan<- prometheus.Metric) error { + lookback := c.config.JobsLookback + if lookback == 0 { + lookback = DefaultJobsLookback + } + slaThreshold := c.config.SLAThresholdSeconds + if slaThreshold == 0 { + slaThreshold = DefaultSLAThresholdSeconds + } + query := BuildJobSLAMissQuery(lookback, slaThreshold) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute job SLA miss query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, jobID, jobName sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &jobID, &jobName, &count); err != nil { + return fmt.Errorf("failed to scan job SLA miss row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.JobSLAMiss, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + jobID.String, + jobName.String, + ) + } + } + + return rows.Err() +} diff --git a/collector/jobs_test.go b/collector/jobs_test.go new file mode 100644 index 0000000..db6c2fd --- /dev/null +++ b/collector/jobs_test.go @@ -0,0 +1,358 @@ +package collector + +import ( + "context" + "errors" + "testing" + + "github.com/DATA-DOG/go-sqlmock" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/testutil" + "github.com/prometheus/common/promslog" +) + +func TestNewJobsCollector(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + if collector == nil { + t.Fatal("expected collector to be created, got nil") + } + + if collector.logger == nil { + t.Error("collector logger should not be nil") + } + + if collector.db == nil { + t.Error("collector db should not be nil") + } + + if collector.metrics == nil { + t.Error("collector metrics should not be nil") + } +} + +func TestJobsCollector_Describe(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + descCh := make(chan *prometheus.Desc, 10) + go func() { + collector.Describe(descCh) + close(descCh) + }() + + descriptions := make([]*prometheus.Desc, 0) + for desc := range descCh { + descriptions = append(descriptions, desc) + } + + expectedCount := 6 // JobRuns, JobRunStatus, JobRunDuration, TaskRetries, JobSLAMiss, ScrapeStatus + if len(descriptions) != expectedCount { + t.Errorf("expected %d metric descriptions, got %d", expectedCount, len(descriptions)) + } +} + +func TestJobsCollector_CollectJobRuns(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock query result + rows := sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "run_count"}). + AddRow("123456789", "job1", "Test Job 1", 150.0). + AddRow("987654321", "job2", "Test Job 2", 75.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the job_runs_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_job_runs_sliding" { + found = true + if len(mf.Metric) != 2 { + t.Errorf("expected 2 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_job_runs_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestJobsCollector_CollectJobRunStatus(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries to prevent errors + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "run_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "status", "run_count"}). + AddRow("123456789", "job1", "Test Job 1", "SUCCESS", 120.0). + AddRow("123456789", "job1", "Test Job 1", "FAILED", 10.0). + AddRow("987654321", "job2", "Test Job 2", "SUCCESS", 60.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "p50", "p95", "p99"})) + + // Note: task_run_timeline query is skipped when CollectTaskRetries=false (default) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "sla_miss_count"})) + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the job_run_status_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_job_run_status_sliding" { + found = true + if len(mf.Metric) != 3 { + t.Errorf("expected 3 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_job_run_status_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestJobsCollector_CollectJobRunDuration(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "status", "run_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "p50", "p95", "p99"}). + AddRow("123456789", "job1", "Test Job 1", 300.5, 850.2, 1200.8) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline").WillReturnRows(rows) + + // Note: task_run_timeline query is skipped when CollectTaskRetries=false (default) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "sla_miss_count"})) + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the job_run_duration_seconds metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_job_run_duration_seconds_sliding" { + found = true + if len(mf.Metric) != 3 { + t.Errorf("expected 3 metrics (p50, p95, p99), got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_job_run_duration_seconds_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestJobsCollector_CollectWithError(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Simulate a query error + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnError(errors.New("database connection lost")) + + // Mock remaining queries as empty + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "p50", "p95", "p99"})) + // Note: task_run_timeline query is skipped when CollectTaskRetries=false (default) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "sla_miss_count"})) + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + ch := make(chan prometheus.Metric, 10) + go func() { + collector.Collect(ch) + close(ch) + }() + + // Drain the channel + count := 0 + for range ch { + count++ + } + + // Should still collect other metrics despite the error + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestJobsCollector_CollectTaskRetries(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "p50", "p95", "p99"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "task_key", "retry_count"}). + AddRow("123456789", "job1", "Test Job 1", "task1", 25.0). + AddRow("987654321", "job2", "Test Job 2", "task2", 12.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_task_run_timeline").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "sla_miss_count"})) + + metrics := NewMetricDescriptors() + // Enable task retries collection for this test + cfg := DefaultConfig() + cfg.CollectTaskRetries = true + collector := NewJobsCollector(context.Background(), db, metrics, cfg, logger) + + ch := make(chan prometheus.Metric, 10) + go func() { + collector.Collect(ch) + close(ch) + }() + + // Drain the channel + for range ch { + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestJobsCollector_CollectJobSLAMiss(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "p50", "p95", "p99"})) + // Note: task_run_timeline query is skipped when CollectTaskRetries=false (default) + + rows := sqlmock.NewRows([]string{"workspace_id", "job_id", "job_name", "sla_miss_count"}). + AddRow("123456789", "job1", "Test Job 1", 5.0). + AddRow("987654321", "job2", "Test Job 2", 2.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.job_run_timeline").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewJobsCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Use testutil to count metrics + count := testutil.CollectAndCount(collector) + + // Should have metrics from all collectors + if count < 2 { + t.Errorf("expected at least 2 SLA miss metrics, got %d", count) + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} diff --git a/collector/metrics.go b/collector/metrics.go new file mode 100644 index 0000000..25bd105 --- /dev/null +++ b/collector/metrics.go @@ -0,0 +1,246 @@ +package collector + +import "github.com/prometheus/client_golang/prometheus" + +// MetricDescriptors holds all Prometheus metric descriptors for the Databricks exporter. +type MetricDescriptors struct { + // Billing & Cost Metrics (FinOps) + BillingDBUs *prometheus.Desc + BillingCostEstimateUSD *prometheus.Desc + PriceChangeEvents *prometheus.Desc + BillingScrapeErrors *prometheus.Desc + + // Jobs Metrics (SRE/Platform) + JobRuns *prometheus.Desc + JobRunStatus *prometheus.Desc + JobRunDurationSeconds *prometheus.Desc + TaskRetries *prometheus.Desc + JobSLAMiss *prometheus.Desc + + // Pipelines Metrics (SRE/Platform) + PipelineRuns *prometheus.Desc + PipelineRunStatus *prometheus.Desc + PipelineRunDurationSeconds *prometheus.Desc + PipelineRetryEvents *prometheus.Desc + PipelineFreshnessLagSeconds *prometheus.Desc + + // SQL Warehouse Metrics (Analytics/BI) + Queries *prometheus.Desc + QueryDurationSeconds *prometheus.Desc + QueryErrors *prometheus.Desc + QueriesRunning *prometheus.Desc + + // Exporter health + ExporterUp *prometheus.Desc + + // Scrape status (per-query health) + ScrapeStatus *prometheus.Desc + + // Exporter info (version and configuration) + ExporterInfo *prometheus.Desc +} + +// NewMetricDescriptors creates and returns all metric descriptors for the Databricks exporter. +func NewMetricDescriptors() *MetricDescriptors { + return &MetricDescriptors{ + // ===== Billing & Cost Metrics (FinOps) ===== + + BillingDBUs: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "billing", "dbus_sliding"), + "Databricks Units (DBUs) consumed per workspace and SKU. "+ + "Note: Databricks billing data has 24-48h lag from actual usage. "+ + "Sliding window configurable via --billing-lookback (default: 24h).", + []string{labelWorkspaceID, labelSKUName}, + nil, + ), + + BillingCostEstimateUSD: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "billing", "cost_estimate_usd_sliding"), + "List-price cost estimate (DBUs × list price) per workspace and SKU. "+ + "Note: Databricks billing data has 24-48h lag from actual usage. "+ + "Sliding window configurable via --billing-lookback (default: 24h).", + []string{labelWorkspaceID, labelSKUName}, + nil, + ), + + PriceChangeEvents: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "price_change_events_sliding"), + "Pricing changes for a SKU. "+ + "Note: Databricks billing data has 24-48h lag. "+ + "Sliding window configurable via --billing-lookback (default: 24h).", + []string{labelSKUName}, + nil, + ), + + BillingScrapeErrors: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "billing", "scrape_errors"), + "Billing scrape errors by stage (1 if error occurred this scrape, 0 otherwise).", + []string{labelStage}, + nil, + ), + + // ===== Jobs Metrics (SRE/Platform) ===== + + JobRuns: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "job_runs_sliding"), + "Lakeflow Jobs runs per workspace and job (sliding window, configurable via --jobs-lookback, default: 3h).", + []string{labelWorkspaceID, labelJobID, labelJobName}, + nil, + ), + + JobRunStatus: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "job_run_status_sliding"), + "Job status counts (SUCCEEDED/FAILED/CANCELED) per workspace and job (sliding window, configurable via --jobs-lookback, default: 3h).", + []string{labelWorkspaceID, labelJobID, labelJobName, labelStatus}, + nil, + ), + + JobRunDurationSeconds: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "job_run_duration_seconds_sliding"), + "Job run duration quantiles (p50/p95/p99) per workspace and job (sliding window, configurable via --jobs-lookback, default: 3h).", + []string{labelWorkspaceID, labelJobID, labelJobName, labelQuantile}, + nil, + ), + + TaskRetries: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "task_retries_sliding"), + "Retries across job tasks per workspace, job, and task key (sliding window, configurable via --jobs-lookback, default: 3h).", + []string{labelWorkspaceID, labelJobID, labelJobName, labelTaskKey}, + nil, + ), + + JobSLAMiss: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "job_sla_miss_sliding"), + "Job runs exceeding SLA threshold (configurable via --sla-threshold) per workspace and job (sliding window, configurable via --jobs-lookback, default: 3h).", + []string{labelWorkspaceID, labelJobID, labelJobName}, + nil, + ), + + // ===== Pipelines Metrics (SRE/Platform) ===== + + PipelineRuns: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "pipeline_runs_sliding"), + "DLT / Lakeflow Pipelines executions per workspace and pipeline (sliding window, configurable via --pipelines-lookback, default: 3h).", + []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + nil, + ), + + PipelineRunStatus: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "pipeline_run_status_sliding"), + "Pipeline run status counts (COMPLETED/FAILED) per workspace and pipeline (sliding window, configurable via --pipelines-lookback, default: 3h).", + []string{labelWorkspaceID, labelPipelineID, labelPipelineName, labelStatus}, + nil, + ), + + PipelineRunDurationSeconds: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "pipeline_run_duration_seconds_sliding"), + "Pipeline run duration quantiles (p50/p95/p99) per workspace and pipeline (sliding window, configurable via --pipelines-lookback, default: 3h).", + []string{labelWorkspaceID, labelPipelineID, labelPipelineName, labelQuantile}, + nil, + ), + + PipelineRetryEvents: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "pipeline_retry_events_sliding"), + "Retry/backoff events within pipeline updates per workspace and pipeline (sliding window, configurable via --pipelines-lookback, default: 3h).", + []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + nil, + ), + + PipelineFreshnessLagSeconds: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "pipeline_freshness_lag_seconds_sliding"), + "Data freshness lag vs target watermark per workspace and pipeline (point-in-time, derived from latest pipeline runs within lookback window).", + []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + nil, + ), + // ===== SQL Warehouse Metrics (Analytics/BI) ===== + + Queries: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "queries_sliding"), + "SQL queries executed (warehouse & serverless) per workspace and warehouse (sliding window, configurable via --queries-lookback, default: 2h).", + []string{labelWorkspaceID, labelWarehouseID}, + nil, + ), + + QueryDurationSeconds: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "query_duration_seconds_sliding"), + "Query latency quantiles (p50/p95/p99) per workspace and warehouse (sliding window, configurable via --queries-lookback, default: 2h).", + []string{labelWorkspaceID, labelWarehouseID, labelQuantile}, + nil, + ), + + QueryErrors: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "query_errors_sliding"), + "Failed queries per workspace and warehouse (sliding window, configurable via --queries-lookback, default: 2h).", + []string{labelWorkspaceID, labelWarehouseID}, + nil, + ), + + QueriesRunning: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "queries_running_sliding"), + "Concurrent/running queries per workspace and warehouse (derived from overlapping intervals within lookback window).", + []string{labelWorkspaceID, labelWarehouseID}, + nil, + ), + + // ===== Exporter Health ===== + + ExporterUp: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "exporter_up"), + "Whether the exporter successfully connected to Databricks. "+ + "1 = connection established, 0 = connection failed. "+ + "Note: Individual query failures do not affect this metric.", + nil, + nil, + ), + + ScrapeStatus: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "scrape_status"), + "Status of individual scrape queries. "+ + "1 = success, 0 = failure (timeout, error, or table unavailable).", + []string{labelQuery}, + nil, + ), + + ExporterInfo: prometheus.NewDesc( + prometheus.BuildFQName(namespace, "", "exporter_info"), + "Build and configuration information for the exporter.", + []string{"version", "billing_window", "jobs_window", "pipelines_window", "queries_window"}, + nil, + ), + } +} + +// Describe sends all metric descriptors to the provided channel. +// This implements the prometheus.Collector interface. +func (m *MetricDescriptors) Describe(ch chan<- *prometheus.Desc) { + // Billing & Cost + ch <- m.BillingDBUs + ch <- m.BillingCostEstimateUSD + ch <- m.PriceChangeEvents + ch <- m.BillingScrapeErrors + + // Jobs + ch <- m.JobRuns + ch <- m.JobRunStatus + ch <- m.JobRunDurationSeconds + ch <- m.TaskRetries + ch <- m.JobSLAMiss + + // Pipelines + ch <- m.PipelineRuns + ch <- m.PipelineRunStatus + ch <- m.PipelineRunDurationSeconds + ch <- m.PipelineRetryEvents + ch <- m.PipelineFreshnessLagSeconds + + // SQL Warehouse + ch <- m.Queries + ch <- m.QueryDurationSeconds + ch <- m.QueryErrors + ch <- m.QueriesRunning + + // Health + ch <- m.ExporterUp + ch <- m.ScrapeStatus + ch <- m.ExporterInfo +} diff --git a/collector/metrics_test.go b/collector/metrics_test.go new file mode 100644 index 0000000..ce8fb63 --- /dev/null +++ b/collector/metrics_test.go @@ -0,0 +1,228 @@ +package collector + +import ( + "strings" + "testing" + + "github.com/prometheus/client_golang/prometheus" +) + +func TestNewMetricDescriptors(t *testing.T) { + metrics := NewMetricDescriptors() + + if metrics == nil { + t.Fatal("NewMetricDescriptors returned nil") + } + + // Test that all metrics are initialized + tests := []struct { + name string + desc *prometheus.Desc + labels []string + }{ + // Billing metrics + { + name: "BillingDBUs", + desc: metrics.BillingDBUs, + labels: []string{labelWorkspaceID, labelSKUName}, + }, + { + name: "BillingCostEstimateUSD", + desc: metrics.BillingCostEstimateUSD, + labels: []string{labelWorkspaceID, labelSKUName}, + }, + { + name: "PriceChangeEvents", + desc: metrics.PriceChangeEvents, + labels: []string{labelSKUName}, + }, + { + name: "BillingScrapeErrors", + desc: metrics.BillingScrapeErrors, + labels: []string{labelStage}, + }, + // Jobs metrics + { + name: "JobRuns", + desc: metrics.JobRuns, + labels: []string{labelWorkspaceID, labelJobID, labelJobName}, + }, + { + name: "JobRunStatus", + desc: metrics.JobRunStatus, + labels: []string{labelWorkspaceID, labelJobID, labelJobName, labelStatus}, + }, + { + name: "JobRunDurationSeconds", + desc: metrics.JobRunDurationSeconds, + labels: []string{labelWorkspaceID, labelJobID, labelJobName, labelQuantile}, + }, + { + name: "TaskRetries", + desc: metrics.TaskRetries, + labels: []string{labelWorkspaceID, labelJobID, labelJobName, labelTaskKey}, + }, + { + name: "JobSLAMiss", + desc: metrics.JobSLAMiss, + labels: []string{labelWorkspaceID, labelJobID, labelJobName}, + }, + // Pipelines metrics + { + name: "PipelineRuns", + desc: metrics.PipelineRuns, + labels: []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + }, + { + name: "PipelineRunStatus", + desc: metrics.PipelineRunStatus, + labels: []string{labelWorkspaceID, labelPipelineID, labelPipelineName, labelStatus}, + }, + { + name: "PipelineRunDurationSeconds", + desc: metrics.PipelineRunDurationSeconds, + labels: []string{labelWorkspaceID, labelPipelineID, labelPipelineName, labelQuantile}, + }, + { + name: "PipelineRetryEvents", + desc: metrics.PipelineRetryEvents, + labels: []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + }, + { + name: "PipelineFreshnessLagSeconds", + desc: metrics.PipelineFreshnessLagSeconds, + labels: []string{labelWorkspaceID, labelPipelineID, labelPipelineName}, + }, + // SQL Warehouse metrics + { + name: "Queries", + desc: metrics.Queries, + labels: []string{labelWorkspaceID, labelWarehouseID}, + }, + { + name: "QueryDurationSeconds", + desc: metrics.QueryDurationSeconds, + labels: []string{labelWorkspaceID, labelWarehouseID, labelQuantile}, + }, + { + name: "QueryErrors", + desc: metrics.QueryErrors, + labels: []string{labelWorkspaceID, labelWarehouseID}, + }, + { + name: "QueriesRunning", + desc: metrics.QueriesRunning, + labels: []string{labelWorkspaceID, labelWarehouseID}, + }, + // Health metrics + { + name: "ExporterUp", + desc: metrics.ExporterUp, + labels: nil, + }, + { + name: "ScrapeStatus", + desc: metrics.ScrapeStatus, + labels: []string{labelQuery}, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if tt.desc == nil { + t.Errorf("%s descriptor is nil", tt.name) + return + } + + // Verify the metric name contains the namespace + descString := tt.desc.String() + if !strings.Contains(descString, namespace) { + t.Errorf("%s: descriptor does not contain namespace '%s': %s", + tt.name, namespace, descString) + } + + // Verify expected label count + // Note: This is a basic check. Prometheus descriptors don't expose label names directly, + // but we can verify the descriptor was created successfully. + if tt.desc.String() == "" { + t.Errorf("%s: descriptor String() is empty", tt.name) + } + }) + } +} + +func TestMetricDescriptors_Describe(t *testing.T) { + metrics := NewMetricDescriptors() + ch := make(chan *prometheus.Desc, 30) // Buffer for all metrics + + // Call Describe + metrics.Describe(ch) + close(ch) + + // Count received descriptors + count := 0 + for range ch { + count++ + } + + // We expect 21 metrics: + // - 4 billing metrics + // - 5 jobs metrics + // - 5 pipelines metrics + // - 4 SQL warehouse metrics + // - 3 health metrics (exporter_up, scrape_status, exporter_info) + expectedCount := 21 + if count != expectedCount { + t.Errorf("Expected %d metric descriptors, got %d", expectedCount, count) + } +} + +func TestMetricDescriptors_AllMetricsHaveDescriptions(t *testing.T) { + metrics := NewMetricDescriptors() + + tests := []struct { + name string + desc *prometheus.Desc + }{ + {"BillingDBUs", metrics.BillingDBUs}, + {"BillingCostEstimateUSD", metrics.BillingCostEstimateUSD}, + {"PriceChangeEvents", metrics.PriceChangeEvents}, + {"BillingScrapeErrors", metrics.BillingScrapeErrors}, + {"JobRuns", metrics.JobRuns}, + {"JobRunStatus", metrics.JobRunStatus}, + {"JobRunDurationSeconds", metrics.JobRunDurationSeconds}, + {"TaskRetries", metrics.TaskRetries}, + {"JobSLAMiss", metrics.JobSLAMiss}, + {"PipelineRuns", metrics.PipelineRuns}, + {"PipelineRunStatus", metrics.PipelineRunStatus}, + {"PipelineRunDurationSeconds", metrics.PipelineRunDurationSeconds}, + {"PipelineRetryEvents", metrics.PipelineRetryEvents}, + {"PipelineFreshnessLagSeconds", metrics.PipelineFreshnessLagSeconds}, + {"Queries", metrics.Queries}, + {"QueryDurationSeconds", metrics.QueryDurationSeconds}, + {"QueryErrors", metrics.QueryErrors}, + {"QueriesRunning", metrics.QueriesRunning}, + {"ExporterUp", metrics.ExporterUp}, + {"ScrapeStatus", metrics.ScrapeStatus}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if tt.desc == nil { + t.Errorf("%s is nil", tt.name) + return + } + + descString := tt.desc.String() + if descString == "" { + t.Errorf("%s has empty description", tt.name) + } + + // Verify help text is not empty + // The String() method includes the help text + if len(descString) < 10 { + t.Errorf("%s description is too short: %s", tt.name, descString) + } + }) + } +} diff --git a/collector/pipelines.go b/collector/pipelines.go new file mode 100644 index 0000000..1c85a69 --- /dev/null +++ b/collector/pipelines.go @@ -0,0 +1,446 @@ +package collector + +import ( + "context" + "database/sql" + "fmt" + "log/slog" + "strings" + "sync" + "time" + + "github.com/prometheus/client_golang/prometheus" +) + +// PipelinesCollector collects pipeline-related metrics from Databricks. +type PipelinesCollector struct { + logger *slog.Logger + db *sql.DB + ctx context.Context + config *Config + + // Metric descriptors + metrics *MetricDescriptors + + // Table availability tracking + mu sync.RWMutex + tableAvailable *bool // nil = unknown, true = available, false = unavailable + tableLastChecked time.Time // when we last checked + tableCheckCounter int // number of scrapes since last check + tableUnavailableOnce sync.Once // ensures we only log unavailability once +} + +// NewPipelinesCollector creates a new PipelinesCollector. +func NewPipelinesCollector(ctx context.Context, db *sql.DB, metrics *MetricDescriptors, config *Config, logger *slog.Logger) *PipelinesCollector { + return &PipelinesCollector{ + logger: logger, + db: db, + metrics: metrics, + ctx: ctx, + config: config, + } +} + +// Describe sends the descriptors of each metric over the provided channel. +func (c *PipelinesCollector) Describe(ch chan<- *prometheus.Desc) { + ch <- c.metrics.PipelineRuns + ch <- c.metrics.PipelineRunStatus + ch <- c.metrics.PipelineRunDurationSeconds + ch <- c.metrics.PipelineRetryEvents + ch <- c.metrics.PipelineFreshnessLagSeconds + ch <- c.metrics.ScrapeStatus +} + +// Collect fetches metrics from Databricks and sends them to Prometheus. +func (c *PipelinesCollector) Collect(ch chan<- prometheus.Metric) { + start := time.Now() + c.logger.Debug("Collecting pipeline metrics") + + // Check if we should verify table availability + if c.shouldCheckTable() { + c.checkTableAvailability() + } + + // Skip collection if table is known to be unavailable + if !c.isTableAvailable() { + c.logger.Debug("Skipping pipeline metrics collection - table unavailable") + // Emit scrape status as 0 when table is unavailable + ch <- prometheus.MustNewConstMetric(c.metrics.ScrapeStatus, prometheus.GaugeValue, 0, "pipelines") + return + } + + var hasError bool + + // Collect each metric, but continue on errors + if err := c.collectPipelineRuns(ch); err != nil { + c.handleCollectionError("pipeline runs", err) + hasError = true + } + + if err := c.collectPipelineRunStatus(ch); err != nil { + c.handleCollectionError("pipeline run status", err) + hasError = true + } + + if err := c.collectPipelineRunDuration(ch); err != nil { + c.handleCollectionError("pipeline run duration", err) + hasError = true + } + + if err := c.collectPipelineRetryEvents(ch); err != nil { + c.handleCollectionError("pipeline retry events", err) + hasError = true + } + + if err := c.collectPipelineFreshnessLag(ch); err != nil { + c.handleCollectionError("pipeline freshness lag", err) + hasError = true + } + + // Emit scrape status + status := 1.0 + if hasError { + status = 0.0 + } + ch <- prometheus.MustNewConstMetric(c.metrics.ScrapeStatus, prometheus.GaugeValue, status, "pipelines") + + c.logger.Debug("Finished collecting pipeline metrics", "duration_seconds", time.Since(start).Seconds()) +} + +// shouldCheckTable determines if we should check table availability. +// Returns true if: +// - We've never checked before (tableAvailable is nil) +// - Enough scrapes have passed since last check +func (c *PipelinesCollector) shouldCheckTable() bool { + c.mu.RLock() + defer c.mu.RUnlock() + + // Always check if we haven't checked yet + if c.tableAvailable == nil { + return true + } + + // If table was unavailable, check periodically + if !*c.tableAvailable && c.tableCheckCounter >= c.config.TableCheckInterval { + return true + } + + return false +} + +// isTableAvailable returns whether the table is available. +// Increments check counter for periodic retries. +func (c *PipelinesCollector) isTableAvailable() bool { + c.mu.Lock() + defer c.mu.Unlock() + + c.tableCheckCounter++ + + // If we don't know yet, assume unavailable + if c.tableAvailable == nil { + return false + } + + return *c.tableAvailable +} + +// checkTableAvailability checks if the pipeline_update_timeline table exists. +func (c *PipelinesCollector) checkTableAvailability() { + c.mu.Lock() + c.tableLastChecked = time.Now() + c.tableCheckCounter = 0 + c.mu.Unlock() + + // Try a simple query to check if the table exists + query := "SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1" + rows, err := c.db.QueryContext(c.ctx, query) + if rows != nil { + rows.Close() + } + + c.mu.Lock() + defer c.mu.Unlock() + + if err != nil { + // Check if it's a "table not found" error + if strings.Contains(strings.ToLower(err.Error()), "table_or_view_not_found") || + strings.Contains(strings.ToLower(err.Error()), "cannot be found") { + + available := false + wasAvailable := c.tableAvailable != nil && *c.tableAvailable + + c.tableAvailable = &available + + // Log once when we first discover the table is unavailable + if c.tableAvailable != nil && !wasAvailable { + c.tableUnavailableOnce.Do(func() { + c.logger.Warn("Pipeline metrics table not available - pipeline metrics will not be collected", + "table", "system.lakeflow.pipeline_update_timeline", + "note", "This is expected in some Databricks environments. All other metrics will continue to work normally.", + "suggestion", "Contact Databricks Support to enable this table, or see documentation for more information.", + ) + }) + } + + c.logger.Debug("Verified table is unavailable", + "table", "system.lakeflow.pipeline_update_timeline", + "will_retry_in_scrapes", c.config.TableCheckInterval, + ) + } else { + // Some other error - log it and assume unavailable for now + c.logger.Debug("Error checking table availability", + "table", "system.lakeflow.pipeline_update_timeline", + "err", err, + ) + available := false + c.tableAvailable = &available + } + } else { + available := true + wasUnavailable := c.tableAvailable != nil && !*c.tableAvailable + + c.tableAvailable = &available + + // Log when table becomes available (was previously unavailable) + if wasUnavailable { + c.logger.Info("Pipeline metrics table is now available - resuming pipeline metrics collection", + "table", "system.lakeflow.pipeline_update_timeline", + ) + } else { + c.logger.Debug("Verified table is available", + "table", "system.lakeflow.pipeline_update_timeline", + ) + } + } +} + +// handleCollectionError handles errors during metric collection. +// If it's a table-not-found error, marks the table as unavailable. +// Otherwise, logs the error. +func (c *PipelinesCollector) handleCollectionError(metricName string, err error) { + errStr := strings.ToLower(err.Error()) + + // Check if this is a table-not-found error + if strings.Contains(errStr, "table_or_view_not_found") || + strings.Contains(errStr, "cannot be found") { + + c.mu.Lock() + available := false + c.tableAvailable = &available + c.mu.Unlock() + + c.logger.Debug("Table became unavailable during collection", + "metric", metricName, + ) + } else { + // Some other error - log it + c.logger.Error("Failed to collect pipeline metric", + "metric", metricName, + "err", err, + ) + } +} + +// collectPipelineRuns collects the total number of pipeline runs per pipeline. +func (c *PipelinesCollector) collectPipelineRuns(ch chan<- prometheus.Metric) error { + lookback := c.config.PipelinesLookback + if lookback == 0 { + lookback = DefaultPipelinesLookback + } + query := BuildPipelineRunsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute pipeline runs query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, pipelineID, pipelineName sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &pipelineID, &pipelineName, &count); err != nil { + return fmt.Errorf("failed to scan pipeline runs row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRuns, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + ) + } + } + + return rows.Err() +} + +// collectPipelineRunStatus collects pipeline run counts by status per pipeline. +func (c *PipelinesCollector) collectPipelineRunStatus(ch chan<- prometheus.Metric) error { + lookback := c.config.PipelinesLookback + if lookback == 0 { + lookback = DefaultPipelinesLookback + } + query := BuildPipelineRunStatusQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute pipeline run status query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, pipelineID, pipelineName, status sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &pipelineID, &pipelineName, &status, &count); err != nil { + return fmt.Errorf("failed to scan pipeline run status row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRunStatus, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + status.String, + ) + } + } + + return rows.Err() +} + +// collectPipelineRunDuration collects pipeline run duration quantiles per pipeline. +func (c *PipelinesCollector) collectPipelineRunDuration(ch chan<- prometheus.Metric) error { + lookback := c.config.PipelinesLookback + if lookback == 0 { + lookback = DefaultPipelinesLookback + } + query := BuildPipelineRunDurationQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute pipeline run duration query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, pipelineID, pipelineName sql.NullString + var p50, p95, p99 sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &pipelineID, &pipelineName, &p50, &p95, &p99); err != nil { + return fmt.Errorf("failed to scan pipeline run duration row: %w", err) + } + + if p50.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRunDurationSeconds, + prometheus.GaugeValue, + p50.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + "0.50", + ) + } + if p95.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRunDurationSeconds, + prometheus.GaugeValue, + p95.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + "0.95", + ) + } + if p99.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRunDurationSeconds, + prometheus.GaugeValue, + p99.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + "0.99", + ) + } + } + + return rows.Err() +} + +// collectPipelineRetryEvents collects the total number of pipeline retry events per pipeline. +func (c *PipelinesCollector) collectPipelineRetryEvents(ch chan<- prometheus.Metric) error { + lookback := c.config.PipelinesLookback + if lookback == 0 { + lookback = DefaultPipelinesLookback + } + query := BuildPipelineRetryEventsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute pipeline retry events query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, pipelineID, pipelineName sql.NullString + var retries sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &pipelineID, &pipelineName, &retries); err != nil { + return fmt.Errorf("failed to scan pipeline retry events row: %w", err) + } + + if retries.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineRetryEvents, + prometheus.GaugeValue, + retries.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + ) + } + } + + return rows.Err() +} + +// collectPipelineFreshnessLag collects pipeline data freshness lag per pipeline. +func (c *PipelinesCollector) collectPipelineFreshnessLag(ch chan<- prometheus.Metric) error { + lookback := c.config.PipelinesLookback + if lookback == 0 { + lookback = DefaultPipelinesLookback + } + query := BuildPipelineFreshnessLagQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute pipeline freshness lag query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, pipelineID, pipelineName sql.NullString + var lagSeconds sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &pipelineID, &pipelineName, &lagSeconds); err != nil { + return fmt.Errorf("failed to scan pipeline freshness lag row: %w", err) + } + + if lagSeconds.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.PipelineFreshnessLagSeconds, + prometheus.GaugeValue, + lagSeconds.Float64, + workspaceID.String, + pipelineID.String, + pipelineName.String, + ) + } + } + + return rows.Err() +} diff --git a/collector/pipelines_test.go b/collector/pipelines_test.go new file mode 100644 index 0000000..5891b78 --- /dev/null +++ b/collector/pipelines_test.go @@ -0,0 +1,383 @@ +package collector + +import ( + "context" + "errors" + "testing" + + "github.com/DATA-DOG/go-sqlmock" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/testutil" + "github.com/prometheus/common/promslog" +) + +func TestNewPipelinesCollector(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + if collector == nil { + t.Fatal("expected collector to be created, got nil") + } + + if collector.logger == nil { + t.Error("collector logger should not be nil") + } + + if collector.db == nil { + t.Error("collector db should not be nil") + } + + if collector.metrics == nil { + t.Error("collector metrics should not be nil") + } +} + +func TestPipelinesCollector_Describe(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + descCh := make(chan *prometheus.Desc, 10) + go func() { + collector.Describe(descCh) + close(descCh) + }() + + descriptions := make([]*prometheus.Desc, 0) + for desc := range descCh { + descriptions = append(descriptions, desc) + } + + expectedCount := 6 // PipelineRuns, PipelineRunStatus, PipelineRunDuration, PipelineRetryEvents, PipelineFreshnessLag, ScrapeStatus + if len(descriptions) != expectedCount { + t.Errorf("expected %d metric descriptions, got %d", expectedCount, len(descriptions)) + } +} + +func TestPipelinesCollector_CollectPipelineRuns(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (must come first) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Mock query result + rows := sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "run_count"}). + AddRow("123456789", "pipe1", "Test Pipeline 1", 200.0). + AddRow("987654321", "pipe2", "Test Pipeline 2", 150.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the pipeline_runs_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_pipeline_runs_sliding" { + found = true + if len(mf.Metric) != 2 { + t.Errorf("expected 2 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_pipeline_runs_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestPipelinesCollector_CollectPipelineRunStatus(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (must come first) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Mock all queries to prevent errors + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "run_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "status", "run_count"}). + AddRow("123456789", "pipe1", "Test Pipeline 1", "COMPLETED", 180.0). + AddRow("123456789", "pipe1", "Test Pipeline 1", "FAILED", 15.0). + AddRow("987654321", "pipe2", "Test Pipeline 2", "COMPLETED", 140.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "p50", "p95", "p99"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "retry_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "lag_seconds"})) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the pipeline_run_status_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_pipeline_run_status_sliding" { + found = true + if len(mf.Metric) != 3 { + t.Errorf("expected 3 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_pipeline_run_status_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestPipelinesCollector_CollectPipelineRunDuration(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (must come first) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "status", "run_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "p50", "p95", "p99"}). + AddRow("123456789", "pipe1", "Test Pipeline 1", 450.5, 1250.8, 2100.3) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "retry_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "lag_seconds"})) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the pipeline_run_duration_seconds metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_pipeline_run_duration_seconds_sliding" { + found = true + if len(mf.Metric) != 3 { + t.Errorf("expected 3 metrics (p50, p95, p99), got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_pipeline_run_duration_seconds_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestPipelinesCollector_CollectWithError(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (table exists) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Simulate a query error + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnError(errors.New("database connection lost")) + + // Mock remaining queries as empty + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "p50", "p95", "p99"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "retry_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "lag_seconds"})) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + ch := make(chan prometheus.Metric, 10) + go func() { + collector.Collect(ch) + close(ch) + }() + + // Drain the channel + count := 0 + for range ch { + count++ + } + + // Should still collect other metrics despite the error + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestPipelinesCollector_CollectRetryEvents(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (must come first) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "p50", "p95", "p99"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "retry_count"}). + AddRow("123456789", "pipe1", "Test Pipeline 1", 18.0). + AddRow("987654321", "pipe2", "Test Pipeline 2", 9.0) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "lag_seconds"})) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + ch := make(chan prometheus.Metric, 10) + go func() { + collector.Collect(ch) + close(ch) + }() + + // Drain the channel + for range ch { + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestPipelinesCollector_CollectFreshnessLag(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock table availability check (must come first) + availRows := sqlmock.NewRows([]string{"1"}).AddRow(1) + mock.ExpectQuery("SELECT 1 FROM system.lakeflow.pipeline_update_timeline LIMIT 1").WillReturnRows(availRows) + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "status", "run_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "p50", "p95", "p99"})) + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "retry_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "pipeline_id", "pipeline_name", "lag_seconds"}). + AddRow("123456789", "pipe1", "Test Pipeline 1", 120.5). + AddRow("123456789", "pipe2", "Test Pipeline 2", 45.2). + AddRow("987654321", "pipe3", "Test Pipeline 3", 200.8) + + mock.ExpectQuery("SELECT(.+)FROM system.lakeflow.pipeline_update_timeline").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewPipelinesCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Use testutil to count metrics + count := testutil.CollectAndCount(collector) + + // Should have metrics from all collectors + if count < 3 { + t.Errorf("expected at least 3 freshness lag metrics, got %d", count) + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} diff --git a/collector/queries.go b/collector/queries.go new file mode 100644 index 0000000..d384224 --- /dev/null +++ b/collector/queries.go @@ -0,0 +1,433 @@ +package collector + +import ( + "fmt" + "time" +) + +// SQL queries for Databricks System Tables +// See: https://docs.databricks.com/aws/en/admin/system-tables + +// durationToSQLInterval converts a Go duration to a Databricks SQL INTERVAL string. +// Uses correct singular/plural grammar (1 HOUR vs 2 HOURS, 1 DAY vs 2 DAYS). +// Note: Databricks SQL accepts both singular and plural forms (e.g., "1 HOUR" and "1 HOURS" +// are both valid), but we use grammatically correct forms for clarity. +// Examples: 24h -> "1 DAY", 48h -> "2 DAYS", 1h -> "1 HOUR", 2h -> "2 HOURS", 30m -> "30 MINUTES" +func durationToSQLInterval(d time.Duration) string { + hours := int(d.Hours()) + if hours >= 24 && hours%24 == 0 { + days := hours / 24 + if days == 1 { + return "1 DAY" + } + return fmt.Sprintf("%d DAYS", days) + } + if hours == 1 { + return "1 HOUR" + } + if hours > 0 { + return fmt.Sprintf("%d HOURS", hours) + } + minutes := int(d.Minutes()) + if minutes == 1 { + return "1 MINUTE" + } + return fmt.Sprintf("%d MINUTES", minutes) +} + +// ===== Billing & Cost Queries ===== + +// BuildBillingDBUsQuery returns the query for DBU consumption with configurable lookback. +func BuildBillingDBUsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + sku_name, + SUM(usage_quantity) as dbus_total + FROM system.billing.usage + WHERE usage_date >= current_date() - INTERVAL %s + AND workspace_id IS NOT NULL + AND sku_name IS NOT NULL + GROUP BY workspace_id, sku_name + ORDER BY workspace_id, sku_name + `, interval) +} + +// BuildBillingCostEstimateQuery returns the query for cost estimates with configurable lookback. +// Uses current prices only (price_end_time IS NULL) to avoid expensive temporal JOINs. +func BuildBillingCostEstimateQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + WITH current_prices AS ( + SELECT DISTINCT sku_name, cloud, pricing.default as unit_price + FROM system.billing.list_prices + WHERE price_end_time IS NULL + ) + SELECT + u.workspace_id, + u.sku_name, + SUM(u.usage_quantity * COALESCE(p.unit_price, 0)) as cost_estimate_usd + FROM system.billing.usage u + LEFT JOIN current_prices p ON u.sku_name = p.sku_name AND u.cloud = p.cloud + WHERE u.usage_date >= current_date() - INTERVAL %s + AND u.workspace_id IS NOT NULL + AND u.sku_name IS NOT NULL + GROUP BY u.workspace_id, u.sku_name + ORDER BY u.workspace_id, u.sku_name + `, interval) +} + +// BuildPriceChangeEventsQuery returns the query for price change events with configurable lookback. +func BuildPriceChangeEventsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + sku_name, + COUNT(*) as price_change_count + FROM system.billing.list_prices + WHERE price_start_time >= current_timestamp() - INTERVAL %s + AND sku_name IS NOT NULL + GROUP BY sku_name + HAVING COUNT(*) > 1 + ORDER BY price_change_count DESC + `, interval) +} + +// ===== Jobs Query Builders ===== + +// BuildJobRunsQuery returns the query for job run counts with configurable lookback. +func BuildJobRunsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.job_id, + COALESCE(j.name, CONCAT('job-', t.job_id)) as job_name, + COUNT(*) as run_count + FROM system.lakeflow.job_run_timeline t + LEFT JOIN ( + SELECT workspace_id, job_id, name + FROM system.lakeflow.jobs + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1 + ) j ON t.workspace_id = j.workspace_id AND t.job_id = j.job_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + GROUP BY t.workspace_id, t.job_id, j.name + `, interval) +} + +// BuildJobRunStatusQuery returns the query for job status counts with configurable lookback. +func BuildJobRunStatusQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.job_id, + COALESCE(j.name, CONCAT('job-', t.job_id)) as job_name, + t.result_state as status, + COUNT(*) as run_count + FROM system.lakeflow.job_run_timeline t + LEFT JOIN ( + SELECT workspace_id, job_id, name + FROM system.lakeflow.jobs + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1 + ) j ON t.workspace_id = j.workspace_id AND t.job_id = j.job_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.result_state IS NOT NULL + GROUP BY t.workspace_id, t.job_id, j.name, t.result_state + `, interval) +} + +// BuildJobRunDurationQuery returns the query for job duration quantiles with configurable lookback. +func BuildJobRunDurationQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + job_id, + job_name, + percentile_approx(duration_seconds, 0.5) as p50, + percentile_approx(duration_seconds, 0.95) as p95, + percentile_approx(duration_seconds, 0.99) as p99 + FROM ( + SELECT + t.workspace_id, + t.job_id, + COALESCE(j.name, CONCAT('job-', t.job_id)) as job_name, + unix_timestamp(t.period_end_time) - unix_timestamp(t.period_start_time) as duration_seconds + FROM system.lakeflow.job_run_timeline t + LEFT JOIN ( + SELECT workspace_id, job_id, name + FROM system.lakeflow.jobs + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1 + ) j ON t.workspace_id = j.workspace_id AND t.job_id = j.job_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.period_end_time IS NOT NULL + AND t.period_end_time > t.period_start_time + ) + GROUP BY workspace_id, job_id, job_name + `, interval) +} + +// BuildTaskRetriesQuery returns the query for task retries with configurable lookback. +func BuildTaskRetriesQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.job_id, + COALESCE(j.name, CONCAT('job-', t.job_id)) as job_name, + t.task_key, + COUNT(*) - COUNT(DISTINCT CONCAT(t.job_run_id, '-', t.task_key)) as retry_count + FROM system.lakeflow.job_task_run_timeline t + LEFT JOIN ( + SELECT workspace_id, job_id, name + FROM system.lakeflow.jobs + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1 + ) j ON t.workspace_id = j.workspace_id AND t.job_id = j.job_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.job_run_id IS NOT NULL + GROUP BY t.workspace_id, t.job_id, j.name, t.task_key + HAVING COUNT(*) > COUNT(DISTINCT CONCAT(t.job_run_id, '-', t.task_key)) + `, interval) +} + +// BuildJobSLAMissQuery returns the query for SLA misses with configurable lookback and threshold. +func BuildJobSLAMissQuery(lookback time.Duration, slaThresholdSeconds int) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + job_id, + job_name, + COUNT(*) as sla_miss_count + FROM ( + SELECT + t.workspace_id, + t.job_id, + COALESCE(j.name, CONCAT('job-', t.job_id)) as job_name, + unix_timestamp(t.period_end_time) - unix_timestamp(t.period_start_time) as duration_seconds + FROM system.lakeflow.job_run_timeline t + LEFT JOIN ( + SELECT workspace_id, job_id, name + FROM system.lakeflow.jobs + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, job_id ORDER BY change_time DESC) = 1 + ) j ON t.workspace_id = j.workspace_id AND t.job_id = j.job_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.period_end_time IS NOT NULL + AND t.period_end_time > t.period_start_time + ) + WHERE duration_seconds > %d + GROUP BY workspace_id, job_id, job_name + `, interval, slaThresholdSeconds) +} + +// ===== Pipelines Query Builders ===== + +// BuildPipelineRunsQuery returns the query for pipeline run counts with configurable lookback. +func BuildPipelineRunsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.pipeline_id, + COALESCE(p.name, CONCAT('pipeline-', t.pipeline_id)) as pipeline_name, + COUNT(*) as run_count + FROM system.lakeflow.pipeline_update_timeline t + LEFT JOIN ( + SELECT workspace_id, pipeline_id, name + FROM system.lakeflow.pipelines + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, pipeline_id ORDER BY change_time DESC) = 1 + ) p ON t.workspace_id = p.workspace_id AND t.pipeline_id = p.pipeline_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + GROUP BY t.workspace_id, t.pipeline_id, p.name + `, interval) +} + +// BuildPipelineRunStatusQuery returns the query for pipeline status counts with configurable lookback. +func BuildPipelineRunStatusQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.pipeline_id, + COALESCE(p.name, CONCAT('pipeline-', t.pipeline_id)) as pipeline_name, + t.result_state as status, + COUNT(*) as run_count + FROM system.lakeflow.pipeline_update_timeline t + LEFT JOIN ( + SELECT workspace_id, pipeline_id, name + FROM system.lakeflow.pipelines + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, pipeline_id ORDER BY change_time DESC) = 1 + ) p ON t.workspace_id = p.workspace_id AND t.pipeline_id = p.pipeline_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.result_state IS NOT NULL + GROUP BY t.workspace_id, t.pipeline_id, p.name, t.result_state + `, interval) +} + +// BuildPipelineRunDurationQuery returns the query for pipeline duration quantiles with configurable lookback. +func BuildPipelineRunDurationQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + pipeline_id, + pipeline_name, + percentile_approx(duration_seconds, 0.5) as p50, + percentile_approx(duration_seconds, 0.95) as p95, + percentile_approx(duration_seconds, 0.99) as p99 + FROM ( + SELECT + t.workspace_id, + t.pipeline_id, + COALESCE(p.name, CONCAT('pipeline-', t.pipeline_id)) as pipeline_name, + unix_timestamp(t.period_end_time) - unix_timestamp(t.period_start_time) as duration_seconds + FROM system.lakeflow.pipeline_update_timeline t + LEFT JOIN ( + SELECT workspace_id, pipeline_id, name + FROM system.lakeflow.pipelines + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, pipeline_id ORDER BY change_time DESC) = 1 + ) p ON t.workspace_id = p.workspace_id AND t.pipeline_id = p.pipeline_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.period_end_time IS NOT NULL + AND t.period_end_time > t.period_start_time + ) + GROUP BY workspace_id, pipeline_id, pipeline_name + `, interval) +} + +// BuildPipelineRetryEventsQuery returns the query for pipeline retry events with configurable lookback. +func BuildPipelineRetryEventsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.pipeline_id, + COALESCE(p.name, CONCAT('pipeline-', t.pipeline_id)) as pipeline_name, + COUNT(*) - COUNT(DISTINCT t.update_id) as retry_count + FROM system.lakeflow.pipeline_update_timeline t + LEFT JOIN ( + SELECT workspace_id, pipeline_id, name + FROM system.lakeflow.pipelines + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, pipeline_id ORDER BY change_time DESC) = 1 + ) p ON t.workspace_id = p.workspace_id AND t.pipeline_id = p.pipeline_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + GROUP BY t.workspace_id, t.pipeline_id, p.name + HAVING COUNT(*) > COUNT(DISTINCT t.update_id) + `, interval) +} + +// BuildPipelineFreshnessLagQuery returns the query for pipeline freshness lag with configurable lookback. +func BuildPipelineFreshnessLagQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + t.workspace_id, + t.pipeline_id, + COALESCE(p.name, CONCAT('pipeline-', t.pipeline_id)) as pipeline_name, + AVG(unix_timestamp(current_timestamp()) - unix_timestamp(t.period_end_time)) as freshness_lag_seconds + FROM system.lakeflow.pipeline_update_timeline t + LEFT JOIN ( + SELECT workspace_id, pipeline_id, name + FROM system.lakeflow.pipelines + WHERE delete_time IS NULL + QUALIFY ROW_NUMBER() OVER (PARTITION BY workspace_id, pipeline_id ORDER BY change_time DESC) = 1 + ) p ON t.workspace_id = p.workspace_id AND t.pipeline_id = p.pipeline_id + WHERE t.period_start_time >= current_timestamp() - INTERVAL %s + AND t.period_end_time IS NOT NULL + AND t.result_state = 'COMPLETED' + GROUP BY t.workspace_id, t.pipeline_id, p.name + `, interval) +} + +// ===== SQL Warehouse Query Builders ===== + +// BuildQueriesQuery returns the query for SQL query counts with configurable lookback. +func BuildQueriesQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + COALESCE(compute.warehouse_id, 'unknown') as warehouse_id, + COUNT(*) as query_count + FROM system.query.history + WHERE start_time >= current_timestamp() - INTERVAL %s + GROUP BY workspace_id, compute.warehouse_id + `, interval) +} + +// BuildQueryErrorsQuery returns the query for SQL query errors with configurable lookback. +func BuildQueryErrorsQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + COALESCE(compute.warehouse_id, 'unknown') as warehouse_id, + COUNT(*) as error_count + FROM system.query.history + WHERE start_time >= current_timestamp() - INTERVAL %s + AND error_message IS NOT NULL + GROUP BY workspace_id, compute.warehouse_id + `, interval) +} + +// BuildQueryDurationQuery returns the query for SQL query duration quantiles with configurable lookback. +func BuildQueryDurationQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + warehouse_id, + percentile_approx(duration_seconds, 0.5) as p50, + percentile_approx(duration_seconds, 0.95) as p95, + percentile_approx(duration_seconds, 0.99) as p99 + FROM ( + SELECT + workspace_id, + COALESCE(compute.warehouse_id, 'unknown') as warehouse_id, + total_duration_ms / 1000.0 as duration_seconds + FROM system.query.history + WHERE start_time >= current_timestamp() - INTERVAL %s + AND total_duration_ms IS NOT NULL + AND total_duration_ms > 0 + ) + GROUP BY workspace_id, warehouse_id + `, interval) +} + +// BuildQueriesRunningQuery returns the query for concurrent queries estimate with configurable lookback. +func BuildQueriesRunningQuery(lookback time.Duration) string { + interval := durationToSQLInterval(lookback) + return fmt.Sprintf(` + SELECT + workspace_id, + warehouse_id, + MAX(concurrent_count) as max_concurrent + FROM ( + SELECT + q1.workspace_id, + COALESCE(q1.compute.warehouse_id, 'unknown') as warehouse_id, + q1.start_time as time_point, + COUNT(*) as concurrent_count + FROM system.query.history q1 + JOIN system.query.history q2 + ON q1.workspace_id = q2.workspace_id + AND COALESCE(q1.compute.warehouse_id, 'unknown') = COALESCE(q2.compute.warehouse_id, 'unknown') + AND q2.start_time <= q1.start_time + AND (q2.end_time >= q1.start_time OR q2.end_time IS NULL) + WHERE q1.start_time >= current_timestamp() - INTERVAL %s + GROUP BY q1.workspace_id, q1.compute.warehouse_id, q1.start_time + ) + GROUP BY workspace_id, warehouse_id + `, interval) +} diff --git a/collector/queries_test.go b/collector/queries_test.go new file mode 100644 index 0000000..33f47d0 --- /dev/null +++ b/collector/queries_test.go @@ -0,0 +1,528 @@ +package collector + +import ( + "strings" + "testing" + "time" +) + +// TestDurationToSQLInterval tests the duration to SQL interval conversion function. +// Databricks SQL accepts both singular and plural forms (e.g., "1 HOUR" and "1 HOURS"), +// but we use grammatically correct forms for clarity. +func TestDurationToSQLInterval(t *testing.T) { + tests := []struct { + name string + duration time.Duration + expected string + }{ + // Days - singular and plural + {"1 day", 24 * time.Hour, "1 DAY"}, + {"2 days", 48 * time.Hour, "2 DAYS"}, + {"3 days", 72 * time.Hour, "3 DAYS"}, + {"7 days", 7 * 24 * time.Hour, "7 DAYS"}, + {"30 days", 30 * 24 * time.Hour, "30 DAYS"}, + {"90 days", 90 * 24 * time.Hour, "90 DAYS"}, + + // Hours - singular and plural + {"1 hour", 1 * time.Hour, "1 HOUR"}, + {"2 hours", 2 * time.Hour, "2 HOURS"}, + {"12 hours", 12 * time.Hour, "12 HOURS"}, + {"23 hours", 23 * time.Hour, "23 HOURS"}, + + // Edge case: 25 hours should be hours, not days + {"25 hours", 25 * time.Hour, "25 HOURS"}, + + // Minutes - singular and plural + {"1 minute", 1 * time.Minute, "1 MINUTE"}, + {"30 minutes", 30 * time.Minute, "30 MINUTES"}, + {"59 minutes", 59 * time.Minute, "59 MINUTES"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + result := durationToSQLInterval(tt.duration) + if result != tt.expected { + t.Errorf("durationToSQLInterval(%v) = %q, want %q", tt.duration, result, tt.expected) + } + }) + } +} + +// ===== Billing Query Builder Tests ===== + +func TestBuildBillingDBUsQuery(t *testing.T) { + tests := []struct { + name string + lookback time.Duration + expectedWindow string + }{ + {"1 day lookback", 24 * time.Hour, "INTERVAL 1 DAY"}, + {"2 days lookback", 48 * time.Hour, "INTERVAL 2 DAYS"}, + {"7 days lookback", 7 * 24 * time.Hour, "INTERVAL 7 DAYS"}, + {"30 days lookback", 30 * 24 * time.Hour, "INTERVAL 30 DAYS"}, + // Edge case: 25 hours should use hours, not days + {"25 hours lookback", 25 * time.Hour, "INTERVAL 25 HOURS"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + query := BuildBillingDBUsQuery(tt.lookback) + if !strings.Contains(query, tt.expectedWindow) { + t.Errorf("BuildBillingDBUsQuery(%v) should contain %q", tt.lookback, tt.expectedWindow) + } + // Verify required elements + if !strings.Contains(query, "system.billing.usage") { + t.Error("Query should reference system.billing.usage") + } + if !strings.Contains(query, "workspace_id") { + t.Error("Query should select workspace_id") + } + if !strings.Contains(query, "sku_name") { + t.Error("Query should select sku_name") + } + }) + } +} + +func TestBuildBillingCostEstimateQuery(t *testing.T) { + tests := []struct { + name string + lookback time.Duration + expectedWindow string + }{ + {"1 day lookback", 24 * time.Hour, "INTERVAL 1 DAY"}, + {"7 days lookback", 7 * 24 * time.Hour, "INTERVAL 7 DAYS"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + query := BuildBillingCostEstimateQuery(tt.lookback) + if !strings.Contains(query, tt.expectedWindow) { + t.Errorf("BuildBillingCostEstimateQuery(%v) should contain %q", tt.lookback, tt.expectedWindow) + } + // Verify joins pricing data + if !strings.Contains(query, "system.billing.list_prices") { + t.Error("Query should reference system.billing.list_prices") + } + }) + } +} + +func TestBuildPriceChangeEventsQuery(t *testing.T) { + tests := []struct { + name string + lookback time.Duration + expectedWindow string + }{ + {"1 day lookback", 24 * time.Hour, "INTERVAL 1 DAY"}, + {"90 days lookback", 90 * 24 * time.Hour, "INTERVAL 90 DAYS"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + query := BuildPriceChangeEventsQuery(tt.lookback) + if !strings.Contains(query, tt.expectedWindow) { + t.Errorf("BuildPriceChangeEventsQuery(%v) should contain %q", tt.lookback, tt.expectedWindow) + } + if !strings.Contains(query, "price_start_time") { + t.Error("Query should filter by price_start_time") + } + }) + } +} + +// ===== Jobs Query Builder Tests ===== + +func TestBuildJobRunsQuery(t *testing.T) { + tests := []struct { + name string + lookback time.Duration + expectedWindow string + }{ + {"1 hour lookback", 1 * time.Hour, "INTERVAL 1 HOUR"}, + {"2 hours lookback", 2 * time.Hour, "INTERVAL 2 HOURS"}, + {"24 hours lookback", 24 * time.Hour, "INTERVAL 1 DAY"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + query := BuildJobRunsQuery(tt.lookback) + if !strings.Contains(query, tt.expectedWindow) { + t.Errorf("BuildJobRunsQuery(%v) should contain %q", tt.lookback, tt.expectedWindow) + } + if !strings.Contains(query, "system.lakeflow.job_run_timeline") { + t.Error("Query should reference system.lakeflow.job_run_timeline") + } + }) + } +} + +func TestBuildJobRunStatusQuery(t *testing.T) { + query := BuildJobRunStatusQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "result_state") { + t.Error("Query should select result_state") + } + if !strings.Contains(query, "system.lakeflow.job_run_timeline") { + t.Error("Query should reference system.lakeflow.job_run_timeline") + } +} + +func TestBuildJobRunDurationQuery(t *testing.T) { + query := BuildJobRunDurationQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "percentile_approx") { + t.Error("Query should use percentile_approx for quantiles") + } + // Verify quantile levels + for _, q := range []string{"0.5", "0.95", "0.99"} { + if !strings.Contains(query, q) { + t.Errorf("Query should calculate %s quantile", q) + } + } +} + +func TestBuildTaskRetriesQuery(t *testing.T) { + query := BuildTaskRetriesQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "system.lakeflow.job_task_run_timeline") { + t.Error("Query should reference system.lakeflow.job_task_run_timeline") + } + if !strings.Contains(query, "retry_count") { + t.Error("Query should calculate retry_count") + } +} + +func TestBuildJobSLAMissQuery(t *testing.T) { + query := BuildJobSLAMissQuery(2*time.Hour, 3600) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "3600") { + t.Error("Query should use SLA threshold of 3600 seconds") + } + if !strings.Contains(query, "sla_miss_count") { + t.Error("Query should calculate sla_miss_count") + } +} + +// ===== Pipelines Query Builder Tests ===== + +func TestBuildPipelineRunsQuery(t *testing.T) { + query := BuildPipelineRunsQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "system.lakeflow.pipeline_update_timeline") { + t.Error("Query should reference system.lakeflow.pipeline_update_timeline") + } +} + +func TestBuildPipelineRunStatusQuery(t *testing.T) { + query := BuildPipelineRunStatusQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "result_state") { + t.Error("Query should select result_state") + } +} + +func TestBuildPipelineRunDurationQuery(t *testing.T) { + query := BuildPipelineRunDurationQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "percentile_approx") { + t.Error("Query should use percentile_approx for quantiles") + } +} + +func TestBuildPipelineRetryEventsQuery(t *testing.T) { + query := BuildPipelineRetryEventsQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "retry_count") { + t.Error("Query should calculate retry_count") + } +} + +func TestBuildPipelineFreshnessLagQuery(t *testing.T) { + query := BuildPipelineFreshnessLagQuery(2 * time.Hour) + if !strings.Contains(query, "INTERVAL 2 HOURS") { + t.Error("Query should contain INTERVAL 2 HOURS") + } + if !strings.Contains(query, "freshness_lag_seconds") { + t.Error("Query should calculate freshness_lag_seconds") + } + if !strings.Contains(query, "COMPLETED") { + t.Error("Query should filter for completed pipelines") + } +} + +// ===== SQL Warehouse Query Builder Tests ===== + +func TestBuildQueriesQuery(t *testing.T) { + tests := []struct { + name string + lookback time.Duration + expectedWindow string + }{ + {"1 hour lookback", 1 * time.Hour, "INTERVAL 1 HOUR"}, + {"2 hours lookback", 2 * time.Hour, "INTERVAL 2 HOURS"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + query := BuildQueriesQuery(tt.lookback) + if !strings.Contains(query, tt.expectedWindow) { + t.Errorf("BuildQueriesQuery(%v) should contain %q", tt.lookback, tt.expectedWindow) + } + if !strings.Contains(query, "system.query.history") { + t.Error("Query should reference system.query.history") + } + }) + } +} + +func TestBuildQueryErrorsQuery(t *testing.T) { + query := BuildQueryErrorsQuery(1 * time.Hour) + if !strings.Contains(query, "INTERVAL 1 HOUR") { + t.Error("Query should contain INTERVAL 1 HOUR") + } + if !strings.Contains(query, "error_message IS NOT NULL") { + t.Error("Query should filter for error_message IS NOT NULL") + } +} + +func TestBuildQueryDurationQuery(t *testing.T) { + query := BuildQueryDurationQuery(1 * time.Hour) + if !strings.Contains(query, "INTERVAL 1 HOUR") { + t.Error("Query should contain INTERVAL 1 HOUR") + } + if !strings.Contains(query, "percentile_approx") { + t.Error("Query should use percentile_approx for quantiles") + } + if !strings.Contains(query, "total_duration_ms") { + t.Error("Query should use total_duration_ms field") + } +} + +func TestBuildQueriesRunningQuery(t *testing.T) { + query := BuildQueriesRunningQuery(1 * time.Hour) + if !strings.Contains(query, "INTERVAL 1 HOUR") { + t.Error("Query should contain INTERVAL 1 HOUR") + } + if !strings.Contains(query, "max_concurrent") { + t.Error("Query should calculate max_concurrent") + } +} + +// ===== Query Properties Tests ===== + +func TestAllQueriesContainSelect(t *testing.T) { + lookback := 2 * time.Hour + billingLookback := 24 * time.Hour + + queries := []struct { + name string + query string + }{ + {"BuildBillingDBUsQuery", BuildBillingDBUsQuery(billingLookback)}, + {"BuildBillingCostEstimateQuery", BuildBillingCostEstimateQuery(billingLookback)}, + {"BuildPriceChangeEventsQuery", BuildPriceChangeEventsQuery(billingLookback)}, + {"BuildJobRunsQuery", BuildJobRunsQuery(lookback)}, + {"BuildJobRunStatusQuery", BuildJobRunStatusQuery(lookback)}, + {"BuildJobRunDurationQuery", BuildJobRunDurationQuery(lookback)}, + {"BuildTaskRetriesQuery", BuildTaskRetriesQuery(lookback)}, + {"BuildJobSLAMissQuery", BuildJobSLAMissQuery(lookback, 3600)}, + {"BuildPipelineRunsQuery", BuildPipelineRunsQuery(lookback)}, + {"BuildPipelineRunStatusQuery", BuildPipelineRunStatusQuery(lookback)}, + {"BuildPipelineRunDurationQuery", BuildPipelineRunDurationQuery(lookback)}, + {"BuildPipelineRetryEventsQuery", BuildPipelineRetryEventsQuery(lookback)}, + {"BuildPipelineFreshnessLagQuery", BuildPipelineFreshnessLagQuery(lookback)}, + {"BuildQueriesQuery", BuildQueriesQuery(lookback)}, + {"BuildQueryErrorsQuery", BuildQueryErrorsQuery(lookback)}, + {"BuildQueryDurationQuery", BuildQueryDurationQuery(lookback)}, + {"BuildQueriesRunningQuery", BuildQueriesRunningQuery(lookback)}, + } + + for _, tt := range queries { + t.Run(tt.name, func(t *testing.T) { + upper := strings.ToUpper(tt.query) + if !strings.Contains(upper, "SELECT") { + t.Errorf("%s does not contain SELECT statement", tt.name) + } + }) + } +} + +func TestAllQueriesContainTimeFilter(t *testing.T) { + lookback := 2 * time.Hour + billingLookback := 24 * time.Hour + + queries := []struct { + name string + query string + }{ + {"BuildBillingDBUsQuery", BuildBillingDBUsQuery(billingLookback)}, + {"BuildBillingCostEstimateQuery", BuildBillingCostEstimateQuery(billingLookback)}, + {"BuildPriceChangeEventsQuery", BuildPriceChangeEventsQuery(billingLookback)}, + {"BuildJobRunsQuery", BuildJobRunsQuery(lookback)}, + {"BuildJobRunStatusQuery", BuildJobRunStatusQuery(lookback)}, + {"BuildJobRunDurationQuery", BuildJobRunDurationQuery(lookback)}, + {"BuildTaskRetriesQuery", BuildTaskRetriesQuery(lookback)}, + {"BuildJobSLAMissQuery", BuildJobSLAMissQuery(lookback, 3600)}, + {"BuildPipelineRunsQuery", BuildPipelineRunsQuery(lookback)}, + {"BuildPipelineRunStatusQuery", BuildPipelineRunStatusQuery(lookback)}, + {"BuildPipelineRunDurationQuery", BuildPipelineRunDurationQuery(lookback)}, + {"BuildPipelineRetryEventsQuery", BuildPipelineRetryEventsQuery(lookback)}, + {"BuildPipelineFreshnessLagQuery", BuildPipelineFreshnessLagQuery(lookback)}, + {"BuildQueriesQuery", BuildQueriesQuery(lookback)}, + {"BuildQueryErrorsQuery", BuildQueryErrorsQuery(lookback)}, + {"BuildQueryDurationQuery", BuildQueryDurationQuery(lookback)}, + {"BuildQueriesRunningQuery", BuildQueriesRunningQuery(lookback)}, + } + + for _, tt := range queries { + t.Run(tt.name, func(t *testing.T) { + upper := strings.ToUpper(tt.query) + hasTimeFilter := strings.Contains(upper, "INTERVAL") || + strings.Contains(upper, "CURRENT_DATE") || + strings.Contains(upper, "CURRENT_TIMESTAMP") + + if !hasTimeFilter { + t.Errorf("%s does not contain time-based filter", tt.name) + } + }) + } +} + +func TestAllQueriesContainAggregation(t *testing.T) { + lookback := 2 * time.Hour + billingLookback := 24 * time.Hour + + queries := []struct { + name string + query string + }{ + {"BuildBillingDBUsQuery", BuildBillingDBUsQuery(billingLookback)}, + {"BuildBillingCostEstimateQuery", BuildBillingCostEstimateQuery(billingLookback)}, + {"BuildPriceChangeEventsQuery", BuildPriceChangeEventsQuery(billingLookback)}, + {"BuildJobRunsQuery", BuildJobRunsQuery(lookback)}, + {"BuildJobRunStatusQuery", BuildJobRunStatusQuery(lookback)}, + {"BuildJobRunDurationQuery", BuildJobRunDurationQuery(lookback)}, + {"BuildTaskRetriesQuery", BuildTaskRetriesQuery(lookback)}, + {"BuildJobSLAMissQuery", BuildJobSLAMissQuery(lookback, 3600)}, + {"BuildPipelineRunsQuery", BuildPipelineRunsQuery(lookback)}, + {"BuildPipelineRunStatusQuery", BuildPipelineRunStatusQuery(lookback)}, + {"BuildPipelineRunDurationQuery", BuildPipelineRunDurationQuery(lookback)}, + {"BuildPipelineRetryEventsQuery", BuildPipelineRetryEventsQuery(lookback)}, + {"BuildPipelineFreshnessLagQuery", BuildPipelineFreshnessLagQuery(lookback)}, + {"BuildQueriesQuery", BuildQueriesQuery(lookback)}, + {"BuildQueryErrorsQuery", BuildQueryErrorsQuery(lookback)}, + {"BuildQueryDurationQuery", BuildQueryDurationQuery(lookback)}, + {"BuildQueriesRunningQuery", BuildQueriesRunningQuery(lookback)}, + } + + for _, tt := range queries { + t.Run(tt.name, func(t *testing.T) { + upper := strings.ToUpper(tt.query) + hasAggregation := strings.Contains(upper, "COUNT(") || + strings.Contains(upper, "SUM(") || + strings.Contains(upper, "AVG(") || + strings.Contains(upper, "MAX(") || + strings.Contains(upper, "MIN(") || + strings.Contains(upper, "PERCENTILE_APPROX(") + + if !hasAggregation { + t.Errorf("%s does not contain aggregation function", tt.name) + } + }) + } +} + +func TestQueriesContainCorrectSystemTable(t *testing.T) { + lookback := 2 * time.Hour + billingLookback := 24 * time.Hour + + tests := []struct { + name string + query string + tableName string + }{ + {"BuildBillingDBUsQuery", BuildBillingDBUsQuery(billingLookback), "system.billing.usage"}, + {"BuildBillingCostEstimateQuery", BuildBillingCostEstimateQuery(billingLookback), "system.billing.usage"}, + {"BuildPriceChangeEventsQuery", BuildPriceChangeEventsQuery(billingLookback), "system.billing.list_prices"}, + {"BuildJobRunsQuery", BuildJobRunsQuery(lookback), "system.lakeflow.job_run_timeline"}, + {"BuildJobRunStatusQuery", BuildJobRunStatusQuery(lookback), "system.lakeflow.job_run_timeline"}, + {"BuildJobRunDurationQuery", BuildJobRunDurationQuery(lookback), "system.lakeflow.job_run_timeline"}, + {"BuildTaskRetriesQuery", BuildTaskRetriesQuery(lookback), "system.lakeflow.job_task_run_timeline"}, + {"BuildJobSLAMissQuery", BuildJobSLAMissQuery(lookback, 3600), "system.lakeflow.job_run_timeline"}, + {"BuildPipelineRunsQuery", BuildPipelineRunsQuery(lookback), "system.lakeflow.pipeline_update_timeline"}, + {"BuildPipelineRunStatusQuery", BuildPipelineRunStatusQuery(lookback), "system.lakeflow.pipeline_update_timeline"}, + {"BuildPipelineRunDurationQuery", BuildPipelineRunDurationQuery(lookback), "system.lakeflow.pipeline_update_timeline"}, + {"BuildPipelineRetryEventsQuery", BuildPipelineRetryEventsQuery(lookback), "system.lakeflow.pipeline_update_timeline"}, + {"BuildPipelineFreshnessLagQuery", BuildPipelineFreshnessLagQuery(lookback), "system.lakeflow.pipeline_update_timeline"}, + {"BuildQueriesQuery", BuildQueriesQuery(lookback), "system.query.history"}, + {"BuildQueryErrorsQuery", BuildQueryErrorsQuery(lookback), "system.query.history"}, + {"BuildQueryDurationQuery", BuildQueryDurationQuery(lookback), "system.query.history"}, + {"BuildQueriesRunningQuery", BuildQueriesRunningQuery(lookback), "system.query.history"}, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if !strings.Contains(tt.query, tt.tableName) { + t.Errorf("%s does not reference expected table %s", tt.name, tt.tableName) + } + }) + } +} + +func TestQueriesContainWorkspaceID(t *testing.T) { + lookback := 2 * time.Hour + billingLookback := 24 * time.Hour + + queries := []struct { + name string + query string + shouldContain bool + }{ + {"BuildBillingDBUsQuery", BuildBillingDBUsQuery(billingLookback), true}, + {"BuildBillingCostEstimateQuery", BuildBillingCostEstimateQuery(billingLookback), true}, + {"BuildPriceChangeEventsQuery", BuildPriceChangeEventsQuery(billingLookback), false}, // No workspace_id + {"BuildJobRunsQuery", BuildJobRunsQuery(lookback), true}, + {"BuildJobRunStatusQuery", BuildJobRunStatusQuery(lookback), true}, + {"BuildJobRunDurationQuery", BuildJobRunDurationQuery(lookback), true}, + {"BuildTaskRetriesQuery", BuildTaskRetriesQuery(lookback), true}, + {"BuildJobSLAMissQuery", BuildJobSLAMissQuery(lookback, 3600), true}, + {"BuildPipelineRunsQuery", BuildPipelineRunsQuery(lookback), true}, + {"BuildPipelineRunStatusQuery", BuildPipelineRunStatusQuery(lookback), true}, + {"BuildPipelineRunDurationQuery", BuildPipelineRunDurationQuery(lookback), true}, + {"BuildPipelineRetryEventsQuery", BuildPipelineRetryEventsQuery(lookback), true}, + {"BuildPipelineFreshnessLagQuery", BuildPipelineFreshnessLagQuery(lookback), true}, + {"BuildQueriesQuery", BuildQueriesQuery(lookback), true}, + {"BuildQueryErrorsQuery", BuildQueryErrorsQuery(lookback), true}, + {"BuildQueryDurationQuery", BuildQueryDurationQuery(lookback), true}, + {"BuildQueriesRunningQuery", BuildQueriesRunningQuery(lookback), true}, + } + + for _, tt := range queries { + t.Run(tt.name, func(t *testing.T) { + containsWorkspaceID := strings.Contains(tt.query, "workspace_id") + if tt.shouldContain && !containsWorkspaceID { + t.Errorf("%s should contain workspace_id but doesn't", tt.name) + } + if !tt.shouldContain && containsWorkspaceID { + t.Errorf("%s should not contain workspace_id but does", tt.name) + } + }) + } +} diff --git a/collector/query.go b/collector/query.go deleted file mode 100644 index bccbf64..0000000 --- a/collector/query.go +++ /dev/null @@ -1,32 +0,0 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package collector - -const ( - // billingMetricQuery retrieves billing and usage information from the system.billing.usage table - // This query aggregates usage data by account, workspace, SKU, cloud provider, and usage unit - billingMetricQuery = ` - SELECT - account_id, - workspace_id, - sku_name, - cloud, - usage_unit, - SUM(usage_quantity) as usage_quantity - FROM system.billing.usage - WHERE usage_date >= date_sub(current_date(), 7) - GROUP BY account_id, workspace_id, sku_name, cloud, usage_unit - ` -) diff --git a/collector/query_test.go b/collector/query_test.go deleted file mode 100644 index 9a81aa6..0000000 --- a/collector/query_test.go +++ /dev/null @@ -1,165 +0,0 @@ -// Copyright 2025 Grafana Labs -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package collector - -import ( - "strings" - "testing" -) - -func TestBillingMetricQuery(t *testing.T) { - // Verify the query is not empty - if billingMetricQuery == "" { - t.Fatal("billingMetricQuery should not be empty") - } - - // Verify the query contains expected SQL keywords - expectedKeywords := []string{ - "SELECT", - "FROM", - "WHERE", - "GROUP BY", - "system.billing.account_prices", - "account_id", - "sku_name", - "cloud", - "currency_code", - "usage_unit", - "pricing", - "AVG", - } - - queryUpper := strings.ToUpper(billingMetricQuery) - - for _, keyword := range expectedKeywords { - if !strings.Contains(queryUpper, strings.ToUpper(keyword)) { - t.Errorf("expected query to contain '%s', but it was not found", keyword) - } - } -} - -func TestBillingMetricQuery_TimeFilter(t *testing.T) { - // Verify the query includes a time filter - // The query should filter data from the last 7 days - if !strings.Contains(billingMetricQuery, "date_sub") { - t.Error("expected query to contain date_sub function for time filtering") - } - - if !strings.Contains(billingMetricQuery, "price_start_time") { - t.Error("expected query to filter on price_start_time") - } - - // Verify it uses current_timestamp() - if !strings.Contains(billingMetricQuery, "current_timestamp()") { - t.Error("expected query to use current_timestamp()") - } -} - -func TestBillingMetricQuery_Aggregation(t *testing.T) { - // Verify the query uses AVG aggregation - if !strings.Contains(strings.ToUpper(billingMetricQuery), "AVG(PRICING)") { - t.Error("expected query to aggregate pricing with AVG function") - } - - // Verify GROUP BY includes all dimension columns - expectedGroupByFields := []string{ - "account_id", - "sku_name", - "cloud", - "currency_code", - "usage_unit", - } - - for _, field := range expectedGroupByFields { - if !strings.Contains(strings.ToLower(billingMetricQuery), field) { - t.Errorf("expected GROUP BY to include field '%s'", field) - } - } -} - -func TestBillingMetricQuery_SelectColumns(t *testing.T) { - // Verify all required columns are selected - requiredColumns := []string{ - "account_id", - "sku_name", - "cloud", - "currency_code", - "usage_unit", - "pricing", - } - - queryLower := strings.ToLower(billingMetricQuery) - - for _, column := range requiredColumns { - if !strings.Contains(queryLower, column) { - t.Errorf("expected query to select column '%s'", column) - } - } -} - -func TestBillingMetricQuery_ValidSQL(t *testing.T) { - // Basic SQL syntax validation - - // Should have balanced parentheses - openCount := strings.Count(billingMetricQuery, "(") - closeCount := strings.Count(billingMetricQuery, ")") - - if openCount != closeCount { - t.Errorf("unbalanced parentheses in query: %d open, %d close", openCount, closeCount) - } - - // Should not contain obvious SQL injection patterns (as a sanity check) - dangerousPatterns := []string{ - "';", - "--", - "/*", - "*/", - "xp_", - "DROP", - "DELETE", - "INSERT", - "UPDATE", - "CREATE", - "ALTER", - } - - queryUpper := strings.ToUpper(billingMetricQuery) - for _, pattern := range dangerousPatterns { - if strings.Contains(queryUpper, strings.ToUpper(pattern)) { - t.Errorf("query contains potentially dangerous pattern: %s", pattern) - } - } -} - -func TestBillingMetricQuery_TableReference(t *testing.T) { - // Verify the query references the correct table - expectedTable := "system.billing.account_prices" - - if !strings.Contains(billingMetricQuery, expectedTable) { - t.Errorf("expected query to reference table '%s'", expectedTable) - } -} - -func TestBillingMetricQuery_TimeWindow(t *testing.T) { - // Verify the query uses a 7-day time window - if !strings.Contains(billingMetricQuery, "7") { - t.Error("expected query to use a 7-day lookback period") - } - - // Should use >= comparison for the date filter - if !strings.Contains(billingMetricQuery, ">=") { - t.Error("expected query to use >= for date comparison") - } -} diff --git a/collector/sql_warehouse.go b/collector/sql_warehouse.go new file mode 100644 index 0000000..90f9b1a --- /dev/null +++ b/collector/sql_warehouse.go @@ -0,0 +1,246 @@ +package collector + +import ( + "context" + "database/sql" + "fmt" + "log/slog" + "time" + + "github.com/prometheus/client_golang/prometheus" +) + +// SQLWarehouseCollector collects SQL warehouse-related metrics from Databricks. +type SQLWarehouseCollector struct { + logger *slog.Logger + db *sql.DB + ctx context.Context + config *Config + + // Metric descriptors + metrics *MetricDescriptors +} + +// NewSQLWarehouseCollector creates a new SQLWarehouseCollector. +func NewSQLWarehouseCollector(ctx context.Context, db *sql.DB, metrics *MetricDescriptors, config *Config, logger *slog.Logger) *SQLWarehouseCollector { + return &SQLWarehouseCollector{ + logger: logger, + db: db, + metrics: metrics, + ctx: ctx, + config: config, + } +} + +// Describe sends the descriptors of each metric over the provided channel. +func (c *SQLWarehouseCollector) Describe(ch chan<- *prometheus.Desc) { + ch <- c.metrics.Queries + ch <- c.metrics.QueryDurationSeconds + ch <- c.metrics.QueryErrors + ch <- c.metrics.QueriesRunning + ch <- c.metrics.ScrapeStatus +} + +// Collect fetches metrics from Databricks and sends them to Prometheus. +func (c *SQLWarehouseCollector) Collect(ch chan<- prometheus.Metric) { + start := time.Now() + c.logger.Debug("Collecting SQL warehouse metrics") + + var hasError bool + + // Collect each metric, but continue on errors + if err := c.collectQueries(ch); err != nil { + c.logger.Error("Failed to collect queries", "err", err) + hasError = true + } + + if err := c.collectQueryErrors(ch); err != nil { + c.logger.Error("Failed to collect query errors", "err", err) + hasError = true + } + + if err := c.collectQueryDuration(ch); err != nil { + c.logger.Error("Failed to collect query duration", "err", err) + hasError = true + } + + if err := c.collectQueriesRunning(ch); err != nil { + c.logger.Error("Failed to collect running queries", "err", err) + hasError = true + } + + // Emit scrape status + status := 1.0 + if hasError { + status = 0.0 + } + ch <- prometheus.MustNewConstMetric(c.metrics.ScrapeStatus, prometheus.GaugeValue, status, "queries") + + c.logger.Debug("Finished collecting SQL warehouse metrics", "duration_seconds", time.Since(start).Seconds()) +} + +// collectQueries collects the total number of queries executed per warehouse. +func (c *SQLWarehouseCollector) collectQueries(ch chan<- prometheus.Metric) error { + lookback := c.config.QueriesLookback + if lookback == 0 { + lookback = DefaultQueriesLookback + } + query := BuildQueriesQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute queries query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, warehouseID sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &warehouseID, &count); err != nil { + return fmt.Errorf("failed to scan queries row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.Queries, + prometheus.GaugeValue, // Gauge because this is a sliding window count that can decrease + count.Float64, + workspaceID.String, + warehouseID.String, + ) + } + } + + return rows.Err() +} + +// collectQueryErrors collects the total number of query errors per warehouse. +func (c *SQLWarehouseCollector) collectQueryErrors(ch chan<- prometheus.Metric) error { + lookback := c.config.QueriesLookback + if lookback == 0 { + lookback = DefaultQueriesLookback + } + query := BuildQueryErrorsQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute query errors query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, warehouseID sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &warehouseID, &count); err != nil { + return fmt.Errorf("failed to scan query errors row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.QueryErrors, + prometheus.GaugeValue, // Gauge because this is a sliding window count that can decrease + count.Float64, + workspaceID.String, + warehouseID.String, + ) + } + } + + return rows.Err() +} + +// collectQueryDuration collects query duration quantiles per warehouse. +func (c *SQLWarehouseCollector) collectQueryDuration(ch chan<- prometheus.Metric) error { + lookback := c.config.QueriesLookback + if lookback == 0 { + lookback = DefaultQueriesLookback + } + query := BuildQueryDurationQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute query duration query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, warehouseID sql.NullString + var p50, p95, p99 sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &warehouseID, &p50, &p95, &p99); err != nil { + return fmt.Errorf("failed to scan query duration row: %w", err) + } + + // Emit p50 + if p50.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.QueryDurationSeconds, + prometheus.GaugeValue, + p50.Float64, + workspaceID.String, + warehouseID.String, + "0.50", + ) + } + + // Emit p95 + if p95.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.QueryDurationSeconds, + prometheus.GaugeValue, + p95.Float64, + workspaceID.String, + warehouseID.String, + "0.95", + ) + } + + // Emit p99 + if p99.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.QueryDurationSeconds, + prometheus.GaugeValue, + p99.Float64, + workspaceID.String, + warehouseID.String, + "0.99", + ) + } + } + + return rows.Err() +} + +// collectQueriesRunning collects the current number of running queries per warehouse. +func (c *SQLWarehouseCollector) collectQueriesRunning(ch chan<- prometheus.Metric) error { + lookback := c.config.QueriesLookback + if lookback == 0 { + lookback = DefaultQueriesLookback + } + query := BuildQueriesRunningQuery(lookback) + rows, err := c.db.QueryContext(c.ctx, query) + if err != nil { + return fmt.Errorf("failed to execute running queries query: %w", err) + } + defer rows.Close() + + for rows.Next() { + var workspaceID, warehouseID sql.NullString + var count sql.NullFloat64 + + if err := rows.Scan(&workspaceID, &warehouseID, &count); err != nil { + return fmt.Errorf("failed to scan running queries row: %w", err) + } + + if count.Valid { + ch <- prometheus.MustNewConstMetric( + c.metrics.QueriesRunning, + prometheus.GaugeValue, + count.Float64, + workspaceID.String, + warehouseID.String, + ) + } + } + + return rows.Err() +} diff --git a/collector/sql_warehouse_test.go b/collector/sql_warehouse_test.go new file mode 100644 index 0000000..a778ba1 --- /dev/null +++ b/collector/sql_warehouse_test.go @@ -0,0 +1,306 @@ +package collector + +import ( + "context" + "errors" + "testing" + + "github.com/DATA-DOG/go-sqlmock" + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/testutil" + "github.com/prometheus/common/promslog" +) + +func TestNewSQLWarehouseCollector(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + if collector == nil { + t.Fatal("expected collector to be created, got nil") + } + + if collector.logger == nil { + t.Error("collector logger should not be nil") + } + + if collector.db == nil { + t.Error("collector db should not be nil") + } + + if collector.metrics == nil { + t.Error("collector metrics should not be nil") + } +} + +func TestSQLWarehouseCollector_Describe(t *testing.T) { + logger := promslog.NewNopLogger() + db, _, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + descCh := make(chan *prometheus.Desc, 10) + go func() { + collector.Describe(descCh) + close(descCh) + }() + + descriptions := make([]*prometheus.Desc, 0) + for desc := range descCh { + descriptions = append(descriptions, desc) + } + + expectedCount := 5 // Queries, QueryDurationSeconds, QueryErrors, QueriesRunning, ScrapeStatus + if len(descriptions) != expectedCount { + t.Errorf("expected %d metric descriptions, got %d", expectedCount, len(descriptions)) + } +} + +func TestSQLWarehouseCollector_CollectQueries(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock query result + rows := sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "query_count"}). + AddRow("123456789", "wh1", 5000.0). + AddRow("987654321", "wh2", 3500.0) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the queries_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_queries_sliding" { + found = true + if len(mf.Metric) != 2 { + t.Errorf("expected 2 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_queries_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestSQLWarehouseCollector_CollectQueryErrors(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries to prevent errors + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "query_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "error_count"}). + AddRow("123456789", "wh1", 25.0). + AddRow("987654321", "wh2", 12.0) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "p50", "p95", "p99"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "max_concurrent"})) + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the query_errors_total metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_query_errors_sliding" { + found = true + if len(mf.Metric) != 2 { + t.Errorf("expected 2 metrics, got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_query_errors_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestSQLWarehouseCollector_CollectQueryDuration(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "query_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "error_count"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "p50", "p95", "p99"}). + AddRow("123456789", "wh1", 2.5, 15.8, 45.3) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history").WillReturnRows(rows) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "max_concurrent"})) + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Create a registry and register the collector + registry := prometheus.NewRegistry() + registry.MustRegister(collector) + + // Gather metrics + metricFamilies, err := registry.Gather() + if err != nil { + t.Fatalf("failed to gather metrics: %v", err) + } + + // Verify the query_duration_seconds metric was collected + found := false + for _, mf := range metricFamilies { + if *mf.Name == "databricks_query_duration_seconds_sliding" { + found = true + if len(mf.Metric) != 3 { + t.Errorf("expected 3 metrics (p50, p95, p99), got %d", len(mf.Metric)) + } + } + } + + if !found { + t.Error("expected databricks_query_duration_seconds_sliding metric not found") + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestSQLWarehouseCollector_CollectWithError(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Simulate a query error + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnError(errors.New("database connection lost")) + + // Mock remaining queries as empty + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "error_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "p50", "p95", "p99"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "max_concurrent"})) + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + ch := make(chan prometheus.Metric, 10) + go func() { + collector.Collect(ch) + close(ch) + }() + + // Drain the channel + count := 0 + for range ch { + count++ + } + + // Should still collect other metrics despite the error + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} + +func TestSQLWarehouseCollector_CollectQueriesRunning(t *testing.T) { + logger := promslog.NewNopLogger() + db, mock, err := sqlmock.New() + if err != nil { + t.Fatalf("failed to create mock db: %v", err) + } + defer db.Close() + + // Mock all queries + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "query_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "error_count"})) + mock.ExpectQuery("SELECT(.+)FROM system.query.history"). + WillReturnRows(sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "p50", "p95", "p99"})) + + rows := sqlmock.NewRows([]string{"workspace_id", "warehouse_id", "max_concurrent"}). + AddRow("123456789", "wh1", 15.0). + AddRow("987654321", "wh2", 8.0) + + mock.ExpectQuery("SELECT(.+)FROM system.query.history").WillReturnRows(rows) + + metrics := NewMetricDescriptors() + collector := NewSQLWarehouseCollector(context.Background(), db, metrics, DefaultConfig(), logger) + + // Use testutil to count metrics + count := testutil.CollectAndCount(collector) + + // Should have metrics from all collectors + if count < 2 { + t.Errorf("expected at least 2 running query metrics, got %d", count) + } + + if err := mock.ExpectationsWereMet(); err != nil { + t.Errorf("unfulfilled expectations: %v", err) + } +} diff --git a/collector/testdata/billing_prices.json b/collector/testdata/billing_prices.json new file mode 100644 index 0000000..ba7b641 --- /dev/null +++ b/collector/testdata/billing_prices.json @@ -0,0 +1,43 @@ +[ + { + "sku_name": "STANDARD_ALL_PURPOSE_COMPUTE", + "cloud": "AWS", + "currency_code": "USD", + "pricing": 0.55, + "price_start_time": "2025-01-01T00:00:00Z", + "price_end_time": null + }, + { + "sku_name": "PREMIUM_JOBS_COMPUTE", + "cloud": "AWS", + "currency_code": "USD", + "pricing": 0.75, + "price_start_time": "2025-01-01T00:00:00Z", + "price_end_time": null + }, + { + "sku_name": "SERVERLESS_SQL", + "cloud": "AWS", + "currency_code": "USD", + "pricing": 0.70, + "price_start_time": "2025-01-01T00:00:00Z", + "price_end_time": null + }, + { + "sku_name": "STANDARD_ALL_PURPOSE_COMPUTE", + "cloud": "AWS", + "currency_code": "USD", + "pricing": 0.50, + "price_start_time": "2024-11-01T00:00:00Z", + "price_end_time": "2024-12-31T23:59:59Z" + }, + { + "sku_name": "PREMIUM_JOBS_COMPUTE", + "cloud": "AWS", + "currency_code": "USD", + "pricing": 0.70, + "price_start_time": "2024-11-01T00:00:00Z", + "price_end_time": "2024-12-31T23:59:59Z" + } +] + diff --git a/collector/testdata/billing_usage.json b/collector/testdata/billing_usage.json new file mode 100644 index 0000000..a909e46 --- /dev/null +++ b/collector/testdata/billing_usage.json @@ -0,0 +1,57 @@ +[ + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654321", + "sku_name": "STANDARD_ALL_PURPOSE_COMPUTE", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 125.5, + "usage_date": "2025-01-10" + }, + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654321", + "sku_name": "PREMIUM_JOBS_COMPUTE", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 450.25, + "usage_date": "2025-01-10" + }, + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654322", + "sku_name": "STANDARD_ALL_PURPOSE_COMPUTE", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 89.75, + "usage_date": "2025-01-10" + }, + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654321", + "sku_name": "STANDARD_ALL_PURPOSE_COMPUTE", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 110.0, + "usage_date": "2025-01-09" + }, + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654321", + "sku_name": "PREMIUM_JOBS_COMPUTE", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 500.5, + "usage_date": "2025-01-09" + }, + { + "account_id": "12345678-1234-1234-1234-123456789012", + "workspace_id": "87654321", + "sku_name": "SERVERLESS_SQL", + "cloud": "AWS", + "usage_unit": "DBU", + "usage_quantity": 75.25, + "usage_date": "2025-01-10" + } +] + diff --git a/docs/databricks-system-tables.md b/docs/databricks-system-tables.md new file mode 100644 index 0000000..f26878a --- /dev/null +++ b/docs/databricks-system-tables.md @@ -0,0 +1,88 @@ +# System tables reference + +The exporter queries several Databricks System Tables to collect metrics. These tables contain operational metadata about your Databricks workloads. + +## `system.billing.usage` + +Contains usage records for all Databricks services. Each row represents a usage event with details about consumption, timestamps, and associated metadata. + +**Key columns:** +- `workspace_id` - ID of the workspace where usage occurred +- `sku_name` - The service or product being consumed +- `usage_quantity` - Amount of usage (typically in DBUs) +- `usage_date` - Date of the usage record +- `cloud` - Cloud provider (AWS, Azure, or GCP) +- `usage_metadata` - Structured metadata including cluster IDs, job IDs, warehouse IDs, etc. + +## `system.billing.list_prices` + +Contains pricing information for Databricks SKUs. Tracks price changes over time with effective date ranges. + +**Key columns:** +- `sku_name` - The service or product name +- `cloud` - Cloud provider +- `pricing` - Structured pricing data (default, promotional, effective_list) +- `price_start_time` - When this price became effective +- `price_end_time` - When this price stopped being effective (NULL if current) +- `currency_code` - Currency for the price + +## `system.lakeflow.job_run_timeline` + +Tracks Databricks job executions at the run level. Each row represents a time period within a job run. + +**Key columns:** +- `workspace_id` - ID of the workspace +- `job_id` - ID of the job definition +- `run_id` - ID of this specific run +- `result_state` - Outcome (SUCCEEDED, FAILED, CANCELED, etc.) +- `period_start_time` - Start time for this period +- `period_end_time` - End time for this period +- `run_type` - Type of run (JOB_RUN, WORKFLOW_RUN, etc.) + +## `system.lakeflow.job_task_run_timeline` + +Tracks individual task executions within jobs. Tasks can retry independently, making this useful for tracking retry behavior. + +**Key columns:** +- `workspace_id` - ID of the workspace +- `job_id` - ID of the parent job +- `job_run_id` - ID of the parent job run +- `run_id` - ID of this specific task run +- `task_key` - Identifier for the task within the job +- `result_state` - Outcome of the task +- `period_start_time` - Start time +- `period_end_time` - End time + +## `system.lakeflow.pipeline_update_timeline` + +Tracks Delta Live Tables (DLT) pipeline update executions. Records both successful and failed pipeline runs. + +> **⚠️ Permissions Note:** This table exists but may require explicit `SELECT` permission for your Service Principal. If the Service Principal lacks permission, you'll see "TABLE_OR_VIEW_NOT_FOUND" errors (even though the table exists). Grant the Service Principal `SELECT` permission on this table, and the exporter will automatically detect it and resume collection. See [Troubleshooting](#pipeline-metrics-not-available-table_or_view_not_found) for details. + +**Key columns:** +- `workspace_id` - ID of the workspace +- `pipeline_id` - ID of the pipeline +- `update_id` - ID of this update +- `request_id` - Request ID (multiple requests for same update indicate retries) +- `result_state` - Outcome of the update +- `period_start_time` - Start time +- `period_end_time` - End time +- `update_type` - Type of update (FULL_REFRESH, INCREMENTAL, etc.) + +## `system.query.history` + +Contains execution history for all SQL queries run in the workspace. Includes queries from SQL warehouses, notebooks, and serverless compute. + +**Key columns:** +- `workspace_id` - ID of the workspace +- `statement_id` - Unique identifier for the statement execution +- `execution_status` - Status (FINISHED, FAILED, CANCELED) +- `start_time` - When execution started +- `end_time` - When execution finished +- `total_duration_ms` - Total execution time in milliseconds +- `error_message` - Error details if the query failed +- `query_source` - Structured data about what triggered the query + +## Metrics + +For the complete list of metrics exported from these system tables, see the **[Metrics Reference](metrics-reference.md)**. diff --git a/docs/metrics-reference.md b/docs/metrics-reference.md new file mode 100644 index 0000000..c6b9d7d --- /dev/null +++ b/docs/metrics-reference.md @@ -0,0 +1,241 @@ +# Metrics reference + +The exporter collects metrics across four categories: billing, jobs, pipelines, and SQL queries. All workload metrics use the `_sliding` suffix to indicate they represent sliding window aggregations. + +> **Note:** Most metrics are Gauges because they represent sliding window counts that can decrease as the window moves forward. See [Lookback Windows](../README.md#lookback-windows) for details. + +## Quick reference + +| Category | Metric | Labels | Description | +|----------|--------|--------|-------------| +| Billing | `databricks_billing_dbus_sliding` | `workspace_id`, `sku_name` | DBUs consumed (24h window) | +| Billing | `databricks_billing_cost_estimate_usd_sliding` | `workspace_id`, `sku_name` | Estimated cost in USD (24h window) | +| Billing | `databricks_price_change_events_sliding` | `sku_name` | Price changes per SKU (24h window) | +| Jobs | `databricks_job_runs_sliding` | `workspace_id`, `job_id`, `job_name` | Job runs count | +| Jobs | `databricks_job_run_status_sliding` | `workspace_id`, `job_id`, `job_name`, `status` | Job runs by status | +| Jobs | `databricks_job_run_duration_seconds_sliding` | `workspace_id`, `job_id`, `job_name`, `quantile` | Job duration quantiles | +| Jobs | `databricks_task_retries_sliding` | `workspace_id`, `job_id`, `job_name`, `task_key` | Task retry counts | +| Jobs | `databricks_job_sla_miss_sliding` | `workspace_id`, `job_id`, `job_name` | Jobs exceeding SLA threshold | +| Pipelines | `databricks_pipeline_runs_sliding` | `workspace_id`, `pipeline_id`, `pipeline_name` | Pipeline runs count | +| Pipelines | `databricks_pipeline_run_status_sliding` | `workspace_id`, `pipeline_id`, `pipeline_name`, `status` | Pipeline runs by status | +| Pipelines | `databricks_pipeline_run_duration_seconds_sliding` | `workspace_id`, `pipeline_id`, `pipeline_name`, `quantile` | Pipeline duration quantiles | +| Pipelines | `databricks_pipeline_retry_events_sliding` | `workspace_id`, `pipeline_id`, `pipeline_name` | Pipeline retry events | +| Pipelines | `databricks_pipeline_freshness_lag_seconds_sliding` | `workspace_id`, `pipeline_id`, `pipeline_name` | Data freshness lag | +| Queries | `databricks_queries_sliding` | `workspace_id`, `warehouse_id` | SQL queries executed | +| Queries | `databricks_query_errors_sliding` | `workspace_id`, `warehouse_id` | Failed SQL queries | +| Queries | `databricks_query_duration_seconds_sliding` | `workspace_id`, `warehouse_id`, `quantile` | Query duration quantiles | +| Queries | `databricks_queries_running_sliding` | `workspace_id`, `warehouse_id` | Concurrent queries estimate | +| Health | `databricks_exporter_up` | — | Exporter connectivity (1=up, 0=down) | +| Health | `databricks_scrape_status` | `query` | Per-query scrape status | +| Health | `databricks_exporter_info` | `version`, `*_window` | Build and config info | + +All metrics also include standard Prometheus labels `job` and `instance` for scrape identification. + +--- + +## Billing and cost metrics + +These metrics help with FinOps and cost tracking. Data has 24-48h lag from actual usage. + +### `databricks_billing_dbus_sliding` + +Sliding window DBU consumption per workspace and SKU (default: last 24 hours). + +- **Source table:** `system.billing.usage` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `sku_name` + +### `databricks_billing_cost_estimate_usd_sliding` + +Estimated cost in USD calculated by joining usage with pricing data (sliding window, default: last 24 hours). + +- **Source tables:** `system.billing.usage`, `system.billing.list_prices` +- **Type:** Gauge (sliding window value that can decrease as the window moves) +- **Labels:** `workspace_id`, `sku_name` + +### `databricks_price_change_events_sliding` + +Count of price changes per SKU within the billing lookback window (default: last 24 hours). Useful for attributing cost changes to pricing vs. usage increases. + +- **Source table:** `system.billing.list_prices` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `sku_name` + +--- + +## Job metrics + +These metrics track Databricks job executions (sliding window, default: last 4 hours). + +### `databricks_job_runs_sliding` + +Job runs per workspace and job within the lookback window. + +- **Source table:** `system.lakeflow.job_run_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `job_id`, `job_name` + +### `databricks_job_run_status_sliding` + +Job run counts broken down by result state. + +- **Source table:** `system.lakeflow.job_run_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `job_id`, `job_name`, `status` +- **Status values:** `SUCCEEDED`, `FAILED`, `CANCELED`, `TIMED_OUT`, etc. + +### `databricks_job_run_duration_seconds_sliding` + +Job run duration quantiles (p50, p95, p99). + +- **Source table:** `system.lakeflow.job_run_timeline` +- **Type:** Gauge +- **Labels:** `workspace_id`, `job_id`, `job_name`, `quantile` +- **Quantile values:** `0.50`, `0.95`, `0.99` + +### `databricks_task_retries_sliding` + +Count of task retry attempts within the lookback window. + +- **Source table:** `system.lakeflow.job_task_run_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `job_id`, `job_name`, `task_key` +- **Note:** Disabled by default due to high cardinality. Enable with `--collect-task-retries`. + +### `databricks_job_sla_miss_sliding` + +Jobs that exceeded the SLA threshold (default: 1 hour) within the lookback window. + +- **Source table:** `system.lakeflow.job_run_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `job_id`, `job_name` + +--- + +## Pipeline metrics + +These metrics track Delta Live Tables (DLT) pipeline executions (sliding window, default: last 4 hours). + +> **⚠️ Permissions Note:** Pipeline metrics require `SELECT` permission on `system.lakeflow.pipeline_update_timeline`. See [Troubleshooting](../README.md#pipeline-metrics-not-available-table_or_view_not_found). + +### `databricks_pipeline_runs_sliding` + +Pipeline update runs per workspace and pipeline within the lookback window. + +- **Source table:** `system.lakeflow.pipeline_update_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `pipeline_id`, `pipeline_name` + +### `databricks_pipeline_run_status_sliding` + +Pipeline run counts broken down by result state. + +- **Source table:** `system.lakeflow.pipeline_update_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `pipeline_id`, `pipeline_name`, `status` +- **Status values:** `COMPLETED`, `FAILED`, `CANCELED`, etc. + +### `databricks_pipeline_run_duration_seconds_sliding` + +Pipeline run duration quantiles (p50, p95, p99). + +- **Source table:** `system.lakeflow.pipeline_update_timeline` +- **Type:** Gauge +- **Labels:** `workspace_id`, `pipeline_id`, `pipeline_name`, `quantile` +- **Quantile values:** `0.50`, `0.95`, `0.99` + +### `databricks_pipeline_retry_events_sliding` + +Pipeline retry events within the lookback window. + +- **Source table:** `system.lakeflow.pipeline_update_timeline` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `pipeline_id`, `pipeline_name` + +### `databricks_pipeline_freshness_lag_seconds_sliding` + +Average time lag between pipeline completion and current time. + +- **Source table:** `system.lakeflow.pipeline_update_timeline` +- **Type:** Gauge +- **Labels:** `workspace_id`, `pipeline_id`, `pipeline_name` + +--- + +## SQL query metrics + +These metrics track SQL query performance across warehouses and serverless compute (sliding window, default: last 2 hours). + +### `databricks_queries_sliding` + +SQL queries executed per workspace and warehouse within the lookback window. + +- **Source table:** `system.query.history` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `warehouse_id` + +### `databricks_query_errors_sliding` + +Failed queries per workspace and warehouse within the lookback window. + +- **Source table:** `system.query.history` +- **Type:** Gauge (sliding window count that can decrease as the window moves) +- **Labels:** `workspace_id`, `warehouse_id` + +### `databricks_query_duration_seconds_sliding` + +Query duration quantiles (p50, p95, p99) in seconds. + +- **Source table:** `system.query.history` +- **Type:** Gauge +- **Labels:** `workspace_id`, `warehouse_id`, `quantile` +- **Quantile values:** `0.50`, `0.95`, `0.99` + +### `databricks_queries_running_sliding` + +Estimated count of concurrent queries (derived from overlapping execution intervals). + +- **Source table:** `system.query.history` +- **Type:** Gauge +- **Labels:** `workspace_id`, `warehouse_id` + +--- + +## System and health metrics + +These metrics are **not** sliding window metrics — they reflect point-in-time exporter state. + +### `databricks_exporter_up` + +Indicates whether the exporter successfully connected to Databricks. + +- **Type:** Gauge +- **Values:** + - `1` - Exporter successfully established database connection + - `0` - Exporter failed to establish database connection +- **Note:** This metric indicates exporter health, not Databricks availability. Individual query failures are logged but do not affect this metric. + +### `databricks_scrape_status` + +Status of individual scrape queries. Provides granular visibility into which system table queries succeeded or failed during each scrape. + +- **Type:** Gauge +- **Labels:** `query` (e.g., `billing`, `jobs`, `pipelines`, `queries`) +- **Values:** + - `1` - Query completed successfully + - `0` - Query failed (timeout, error, or table unavailable) + +### `databricks_exporter_info` + +Build and configuration information for the exporter. Useful for tracking deployed versions and configured lookback windows across instances. + +- **Type:** Gauge (always 1) +- **Labels:** `version`, `billing_window`, `jobs_window`, `pipelines_window`, `queries_window` + +### `databricks_billing_scrape_errors` + +Count of errors encountered during billing data collection. + +- **Type:** Counter +- **Labels:** `workspace_id` + diff --git a/go.mod b/go.mod index 1011e90..481afe1 100644 --- a/go.mod +++ b/go.mod @@ -1,43 +1,47 @@ module github.com/grafana/databricks-prometheus-exporter -go 1.24.0 - -toolchain go1.24.10 +go 1.25.5 require ( + github.com/DATA-DOG/go-sqlmock v1.5.2 github.com/alecthomas/kingpin/v2 v2.4.0 - github.com/databricks/databricks-sql-go v1.6.0 - github.com/go-kit/log v0.2.1 - github.com/prometheus/client_golang v1.20.5 - github.com/prometheus/common v0.60.1 - github.com/prometheus/exporter-toolkit v0.13.1 + github.com/databricks/databricks-sql-go v1.9.0 + github.com/prometheus/client_golang v1.23.2 + github.com/prometheus/client_model v0.6.2 + github.com/prometheus/common v0.67.4 + github.com/prometheus/exporter-toolkit v0.15.0 + github.com/stretchr/testify v1.11.1 ) require ( - github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect - github.com/andybalholm/brotli v1.0.4 // indirect + github.com/alecthomas/units v0.0.0-20240927000941-0f3dac36c52b // indirect + github.com/andybalholm/brotli v1.2.0 // indirect github.com/apache/arrow/go/v12 v12.0.1 // indirect - github.com/apache/thrift v0.17.0 // indirect + github.com/apache/thrift v0.22.0 // indirect github.com/beorn7/perks v1.0.1 // indirect + github.com/bitfield/gotestdox v0.2.2 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect - github.com/coreos/go-oidc/v3 v3.5.0 // indirect - github.com/coreos/go-systemd/v22 v22.5.0 // indirect + github.com/coreos/go-oidc/v3 v3.17.0 // indirect + github.com/coreos/go-systemd/v22 v22.6.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect github.com/dnephin/pflag v1.0.7 // indirect - github.com/fatih/color v1.16.0 // indirect - github.com/fsnotify/fsnotify v1.5.4 // indirect - github.com/go-jose/go-jose/v3 v3.0.4 // indirect - github.com/go-logfmt/logfmt v0.5.1 // indirect - github.com/goccy/go-json v0.9.11 // indirect - github.com/golang/snappy v0.0.4 // indirect - github.com/google/flatbuffers v2.0.8+incompatible // indirect + github.com/fatih/color v1.18.0 // indirect + github.com/fsnotify/fsnotify v1.9.0 // indirect + github.com/go-jose/go-jose/v4 v4.1.3 // indirect + github.com/goccy/go-json v0.10.5 // indirect + github.com/golang-jwt/jwt/v5 v5.3.0 // indirect + github.com/golang/snappy v1.0.0 // indirect + github.com/google/flatbuffers v25.9.23+incompatible // indirect github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 // indirect + github.com/google/uuid v1.6.0 // indirect github.com/hashicorp/go-cleanhttp v0.5.2 // indirect - github.com/hashicorp/go-retryablehttp v0.7.7 // indirect + github.com/hashicorp/go-retryablehttp v0.7.8 // indirect github.com/jpillora/backoff v1.0.0 // indirect github.com/klauspost/asmfmt v1.3.2 // indirect - github.com/klauspost/compress v1.17.9 // indirect - github.com/klauspost/cpuid/v2 v2.0.9 // indirect - github.com/mattn/go-colorable v0.1.13 // indirect + github.com/klauspost/compress v1.18.2 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect + github.com/kylelemons/godebug v1.1.0 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect github.com/mattn/go-isatty v0.0.20 // indirect github.com/mdlayher/socket v0.4.1 // indirect github.com/mdlayher/vsock v1.2.1 // indirect @@ -45,26 +49,28 @@ require ( github.com/minio/c2goasm v0.0.0-20190812172519-36a3d3bbc4f3 // indirect github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect - github.com/pierrec/lz4/v4 v4.1.15 // indirect - github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 // indirect + github.com/pierrec/lz4/v4 v4.1.22 // indirect + github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect github.com/pkg/errors v0.9.1 // indirect - github.com/prometheus/client_model v0.6.1 // indirect - github.com/prometheus/procfs v0.15.1 // indirect - github.com/rs/zerolog v1.28.0 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/prometheus/procfs v0.16.1 // indirect + github.com/rs/zerolog v1.34.0 // indirect github.com/xhit/go-str2duration/v2 v2.1.0 // indirect github.com/zeebo/xxh3 v1.0.2 // indirect - golang.org/x/crypto v0.45.0 // indirect - golang.org/x/mod v0.29.0 // indirect - golang.org/x/net v0.47.0 // indirect - golang.org/x/oauth2 v0.27.0 // indirect - golang.org/x/sync v0.18.0 // indirect - golang.org/x/sys v0.38.0 // indirect - golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8 // indirect - golang.org/x/term v0.37.0 // indirect - golang.org/x/text v0.31.0 // indirect - golang.org/x/tools v0.38.0 // indirect - golang.org/x/xerrors v0.0.0-20220609144429-65e65417b02f // indirect - google.golang.org/protobuf v1.34.2 // indirect - gopkg.in/yaml.v2 v2.4.0 // indirect - gotest.tools/gotestsum v1.8.2 // indirect + go.yaml.in/yaml/v2 v2.4.3 // indirect + golang.org/x/crypto v0.46.0 // indirect + golang.org/x/mod v0.31.0 // indirect + golang.org/x/net v0.48.0 // indirect + golang.org/x/oauth2 v0.34.0 // indirect + golang.org/x/sync v0.19.0 // indirect + golang.org/x/sys v0.39.0 // indirect + golang.org/x/telemetry v0.0.0-20251215142616-e75fd47794af // indirect + golang.org/x/term v0.38.0 // indirect + golang.org/x/text v0.32.0 // indirect + golang.org/x/time v0.13.0 // indirect + golang.org/x/tools v0.40.0 // indirect + golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da // indirect + google.golang.org/protobuf v1.36.10 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect + gotest.tools/gotestsum v1.13.0 // indirect ) diff --git a/go.sum b/go.sum index 77a6745..54fc605 100644 --- a/go.sum +++ b/go.sum @@ -1,94 +1,82 @@ -cloud.google.com/go/compute/metadata v0.2.0/go.mod h1:zFmK7XCadkQkj6TtorcaGlCW1hT1fIilQDwofLpJ20k= +github.com/DATA-DOG/go-sqlmock v1.5.2 h1:OcvFkGmslmlZibjAjaHm3L//6LiuBgolP7OputlJIzU= +github.com/DATA-DOG/go-sqlmock v1.5.2/go.mod h1:88MAG/4G7SMwSE3CeA0ZKzrT5CiOU3OJ+JlNzwDqpNU= github.com/JohnCGriffin/overflow v0.0.0-20211019200055-46fa312c352c h1:RGWPOewvKIROun94nF7v2cua9qP+thov/7M50KEoeSU= github.com/JohnCGriffin/overflow v0.0.0-20211019200055-46fa312c352c/go.mod h1:X0CRv0ky0k6m906ixxpzmDRLvX58TFUKS2eePweuyxk= github.com/alecthomas/kingpin/v2 v2.4.0 h1:f48lwail6p8zpO1bC4TxtqACaGqHYA22qkHjHpqDjYY= github.com/alecthomas/kingpin/v2 v2.4.0/go.mod h1:0gyi0zQnjuFk8xrkNKamJoyUo382HRL7ATRpFZCw6tE= -github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 h1:s6gZFSlWYmbqAuRjVTiNNhvNRfY2Wxp9nhfyel4rklc= -github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE= -github.com/andybalholm/brotli v1.0.4 h1:V7DdXeJtZscaqfNuAdSRuRFzuiKlHSC/Zh3zl9qY3JY= -github.com/andybalholm/brotli v1.0.4/go.mod h1:fO7iG3H7G2nSZ7m0zPUDn85XEX2GTukHGRSepvi9Eig= +github.com/alecthomas/units v0.0.0-20240927000941-0f3dac36c52b h1:mimo19zliBX/vSQ6PWWSL9lK8qwHozUj03+zLoEB8O0= +github.com/alecthomas/units v0.0.0-20240927000941-0f3dac36c52b/go.mod h1:fvzegU4vN3H1qMT+8wDmzjAcDONcgo2/SZ/TyfdUOFs= +github.com/andybalholm/brotli v1.2.0 h1:ukwgCxwYrmACq68yiUqwIWnGY0cTPox/M94sVwToPjQ= +github.com/andybalholm/brotli v1.2.0/go.mod h1:rzTDkvFWvIrjDXZHkuS16NPggd91W3kUSvPlQ1pLaKY= github.com/apache/arrow/go/v12 v12.0.1 h1:JsR2+hzYYjgSUkBSaahpqCetqZMr76djX80fF/DiJbg= github.com/apache/arrow/go/v12 v12.0.1/go.mod h1:weuTY7JvTG/HDPtMQxEUp7pU73vkLWMLpY67QwZ/WWw= -github.com/apache/thrift v0.17.0 h1:cMd2aj52n+8VoAtvSvLn4kDC3aZ6IAkBuqWQ2IDu7wo= -github.com/apache/thrift v0.17.0/go.mod h1:OLxhMRJxomX+1I/KUw03qoV3mMz16BwaKI+d4fPBx7Q= +github.com/apache/thrift v0.22.0 h1:r7mTJdj51TMDe6RtcmNdQxgn9XcyfGDOzegMDRg47uc= +github.com/apache/thrift v0.22.0/go.mod h1:1e7J/O1Ae6ZQMTYdy9xa3w9k+XHWPfRvdPyJeynQ+/g= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/bitfield/gotestdox v0.2.2 h1:x6RcPAbBbErKLnapz1QeAlf3ospg8efBsedU93CDsnE= +github.com/bitfield/gotestdox v0.2.2/go.mod h1:D+gwtS0urjBrzguAkTM2wodsTQYFHdpx8eqRJ3N+9pY= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= -github.com/coreos/go-oidc/v3 v3.5.0 h1:VxKtbccHZxs8juq7RdJntSqtXFtde9YpNpGn0yqgEHw= -github.com/coreos/go-oidc/v3 v3.5.0/go.mod h1:ecXRtV4romGPeO6ieExAsUK9cb/3fp9hXNz1tlv8PIM= -github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= -github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs= +github.com/coreos/go-oidc/v3 v3.17.0 h1:hWBGaQfbi0iVviX4ibC7bk8OKT5qNr4klBaCHVNvehc= +github.com/coreos/go-oidc/v3 v3.17.0/go.mod h1:wqPbKFrVnE90vty060SB40FCJ8fTHTxSwyXJqZH+sI8= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= -github.com/databricks/databricks-sql-go v1.6.0 h1:sYAvzZ8f3LRe/c2OWxxoc4dyjPMvyFMDBJQMh+6r5Ao= -github.com/databricks/databricks-sql-go v1.6.0/go.mod h1:/FB8hVRN/KGnWStEyz19r2r7TmfBsK8nUv6yMid//tU= +github.com/coreos/go-systemd/v22 v22.6.0 h1:aGVa/v8B7hpb0TKl0MWoAavPDmHvobFe5R5zn0bCJWo= +github.com/coreos/go-systemd/v22 v22.6.0/go.mod h1:iG+pp635Fo7ZmV/j14KUcmEyWF+0X7Lua8rrTWzYgWU= +github.com/databricks/databricks-sql-go v1.9.0 h1:h5w5E3FDMFXHqV7d5w5q3HCq1MVQswjSQfGx+43ThcI= +github.com/databricks/databricks-sql-go v1.9.0/go.mod h1:TGAVzvXadeKI8me3nKBa/2phLNnyWR6OolYq6iYbN3E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/dnephin/pflag v1.0.7 h1:oxONGlWxhmUct0YzKTgrpQv9AUA1wtPBn7zuSjJqptk= github.com/dnephin/pflag v1.0.7/go.mod h1:uxE91IoWURlOiTUIA8Mq5ZZkAv3dPUfZNaT80Zm7OQE= -github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= -github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM= -github.com/fatih/color v1.16.0/go.mod h1:fL2Sau1YI5c0pdGEVCbKQbLXB6edEj1ZgiY4NijnWvE= -github.com/fsnotify/fsnotify v1.5.4 h1:jRbGcIw6P2Meqdwuo0H1p6JVLbL5DHKAKlYndzMwVZI= -github.com/fsnotify/fsnotify v1.5.4/go.mod h1:OVB6XrOHzAwXMpEM7uPOzcehqUV2UqJxmVXmkdnm1bU= -github.com/go-jose/go-jose/v3 v3.0.0/go.mod h1:RNkWWRld676jZEYoV3+XK8L2ZnNSvIsxFMht0mSX+u8= -github.com/go-jose/go-jose/v3 v3.0.4 h1:Wp5HA7bLQcKnf6YYao/4kpRpVMp/yf6+pJKV8WFSaNY= -github.com/go-jose/go-jose/v3 v3.0.4/go.mod h1:5b+7YgP7ZICgJDBdfjZaIt+H/9L9T/YQrVfLAMboGkQ= -github.com/go-kit/log v0.2.1 h1:MRVx0/zhvdseW+Gza6N9rVzU/IVzaeE1SFI4raAhmBU= -github.com/go-kit/log v0.2.1/go.mod h1:NwTd00d/i8cPZ3xOwwiv2PO5MOcx78fFErGNcVmBjv0= -github.com/go-logfmt/logfmt v0.5.1 h1:otpy5pqBCBZ1ng9RQ0dPu4PN7ba75Y/aA+UpowDyNVA= -github.com/go-logfmt/logfmt v0.5.1/go.mod h1:WYhtIu8zTZfxdn5+rREduYbwxfcBr/Vr6KEVveWlfTs= -github.com/goccy/go-json v0.9.11 h1:/pAaQDLHEoCq/5FFmSKBswWmK6H0e8g4159Kc/X/nqk= -github.com/goccy/go-json v0.9.11/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM= +github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU= +github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k= +github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= +github.com/go-jose/go-jose/v4 v4.1.3 h1:CVLmWDhDVRa6Mi/IgCgaopNosCaHz7zrMeF9MlZRkrs= +github.com/go-jose/go-jose/v4 v4.1.3/go.mod h1:x4oUasVrzR7071A4TnHLGSPpNOm2a21K9Kf04k1rs08= +github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= +github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= -github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= -github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= -github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM= -github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= -github.com/google/flatbuffers v2.0.8+incompatible h1:ivUb1cGomAB101ZM1T0nOiWz9pSrTMoa9+EiY7igmkM= -github.com/google/flatbuffers v2.0.8+incompatible/go.mod h1:1AeVuKshWv4vARoZatz6mlQ0JxURH0Kv5+zNeJKJCa8= -github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= -github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= -github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= -github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/golang-jwt/jwt/v5 v5.3.0 h1:pv4AsKCKKZuqlgs5sUmn4x8UlGa0kEVt/puTpKx9vvo= +github.com/golang-jwt/jwt/v5 v5.3.0/go.mod h1:fxCRLWMO43lRc8nhHWY6LGqRcf+1gQWArsqaEUEa5bE= +github.com/golang/snappy v1.0.0 h1:Oy607GVXHs7RtbggtPBnr2RmDArIsAefDwvrdWvRhGs= +github.com/golang/snappy v1.0.0/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q= +github.com/google/flatbuffers v25.9.23+incompatible h1:rGZKv+wOb6QPzIdkM2KxhBZCDrA0DeN6DNmRDrqIsQU= +github.com/google/flatbuffers v25.9.23+incompatible/go.mod h1:1AeVuKshWv4vARoZatz6mlQ0JxURH0Kv5+zNeJKJCa8= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ= -github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= -github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= github.com/hashicorp/go-hclog v1.6.3 h1:Qr2kF+eVWjTiYmU7Y31tYlP1h0q/X3Nl3tPGdaB11/k= github.com/hashicorp/go-hclog v1.6.3/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= -github.com/hashicorp/go-retryablehttp v0.7.7 h1:C8hUCYzor8PIfXHa4UrZkU4VvK8o9ISHxT2Q8+VepXU= -github.com/hashicorp/go-retryablehttp v0.7.7/go.mod h1:pkQpWZeYWskR+D1tR2O5OcBFOxfA7DoAO6xtkuQnHTk= +github.com/hashicorp/go-retryablehttp v0.7.8 h1:ylXZWnqa7Lhqpk0L1P1LzDtGcCR0rPVUrx/c8Unxc48= +github.com/hashicorp/go-retryablehttp v0.7.8/go.mod h1:rjiScheydd+CxvumBsIrFKlx3iS0jrZ7LvzFGFmuKbw= github.com/jpillora/backoff v1.0.0 h1:uvFg412JmmHBHw7iwprIxkPMI+sGQ4kzOWsMeHnm2EA= github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4= +github.com/kisielk/sqlstruct v0.0.0-20201105191214-5f3e10d3ab46/go.mod h1:yyMNCyc/Ib3bDTKd379tNMpB/7/H5TjM2Y9QJ5THLbE= github.com/klauspost/asmfmt v1.3.2 h1:4Ri7ox3EwapiOjCki+hw14RyKk201CN4rzyCJRFLpK4= github.com/klauspost/asmfmt v1.3.2/go.mod h1:AG8TuvYojzulgDAMCnYn50l/5QV3Bs/tp6j0HLHbNSE= -github.com/klauspost/compress v1.17.9 h1:6KIumPrER1LHsvBVuDa0r5xaG0Es51mhhB9BQB2qeMA= -github.com/klauspost/compress v1.17.9/go.mod h1:Di0epgTjJY877eYKx5yC51cX2A2Vl2ibi7bDH9ttBbw= -github.com/klauspost/cpuid/v2 v2.0.9 h1:lgaqFMSdTdQYdZ04uHyN2d/eKdOMyi2YLSvlQIBFYa4= -github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= -github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/klauspost/compress v1.18.2 h1:iiPHWW0YrcFgpBYhsA6D1+fqHssJscY/Tm/y2Uqnapk= +github.com/klauspost/compress v1.18.2/go.mod h1:R0h/fSBs8DE4ENlcrlib3PsXS61voFxhIs2DeRhCvJ4= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= -github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= -github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= -github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= -github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= -github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= -github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U= @@ -103,164 +91,92 @@ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f h1:KUppIJq7/+SVif2QVs3tOP0zanoHgBEVAwHxUSIzRqU= github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= -github.com/pierrec/lz4/v4 v4.1.15 h1:MO0/ucJhngq7299dKLwIMtgTfbkoSPF6AoMYDd8Q4q0= -github.com/pierrec/lz4/v4 v4.1.15/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4= -github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU= -github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI= +github.com/pierrec/lz4/v4 v4.1.22 h1:cKFw6uJDK+/gfw5BcDL0JL5aBsAFdsIT18eRtLj7VIU= +github.com/pierrec/lz4/v4 v4.1.22/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/prometheus/client_golang v1.20.5 h1:cxppBPuYhUnsO6yo/aoRol4L7q7UFfdm+bR9r+8l63Y= -github.com/prometheus/client_golang v1.20.5/go.mod h1:PIEt8X02hGcP8JWbeHyeZ53Y/jReSnHgO035n//V5WE= -github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= -github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= -github.com/prometheus/common v0.60.1 h1:FUas6GcOw66yB/73KC+BOZoFJmbo/1pojoILArPAaSc= -github.com/prometheus/common v0.60.1/go.mod h1:h0LYf1R1deLSKtD4Vdg8gy4RuOvENW2J/h19V5NADQw= -github.com/prometheus/exporter-toolkit v0.13.1 h1:Evsh0gWQo2bdOHlnz9+0Nm7/OFfIwhE2Ws4A2jIlR04= -github.com/prometheus/exporter-toolkit v0.13.1/go.mod h1:ujdv2YIOxtdFxxqtloLpbqmxd5J0Le6IITUvIRSWjj0= -github.com/prometheus/procfs v0.15.1 h1:YagwOFzUgYfKKHX6Dr+sHT7km/hxC76UB0learggepc= -github.com/prometheus/procfs v0.15.1/go.mod h1:fB45yRUv8NstnjriLhBQLuOUt+WW4BsoGhij/e3PBqk= -github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ= -github.com/rogpeppe/go-internal v1.10.0/go.mod h1:UQnix2H7Ngw/k4C5ijL5+65zddjncjaFoBhdsK/akog= -github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= -github.com/rs/zerolog v1.28.0 h1:MirSo27VyNi7RJYP3078AA1+Cyzd2GB66qy3aUHvsWY= -github.com/rs/zerolog v1.28.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= -github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4= +github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o= +github.com/prometheus/client_golang v1.23.2/go.mod h1:Tb1a6LWHB3/SPIzCoaDXI4I8UHKeFTEQ1YCr+0Gyqmg= +github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= +github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= +github.com/prometheus/common v0.67.4 h1:yR3NqWO1/UyO1w2PhUvXlGQs/PtFmoveVO0KZ4+Lvsc= +github.com/prometheus/common v0.67.4/go.mod h1:gP0fq6YjjNCLssJCQp0yk4M8W6ikLURwkdd/YKtTbyI= +github.com/prometheus/exporter-toolkit v0.15.0 h1:Pcle5sSViwR1x0gdPd0wtYrPQENBieQAM7TmT0qtb2U= +github.com/prometheus/exporter-toolkit v0.15.0/go.mod h1:OyRWd2iTo6Xge9Kedvv0IhCrJSBu36JCfJ2yVniRIYk= +github.com/prometheus/procfs v0.16.1 h1:hZ15bTNuirocR6u0JZ6BAHHmwS1p8B4P6MRqxtzMyRg= +github.com/prometheus/procfs v0.16.1/go.mod h1:teAbpZRB1iIAJYREa1LsoWUXykVXA1KlTmWl8x/U+Is= +github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= +github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= +github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0= +github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY= +github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= -github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/xhit/go-str2duration/v2 v2.1.0 h1:lxklc02Drh6ynqX+DdPyp5pCKLUQpRT8bp8Ydu2Bstc= github.com/xhit/go-str2duration/v2 v2.1.0/go.mod h1:ohY8p+0f07DiV6Em5LKB0s2YpLtXVyJfNt1+BlmyAsU= -github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= -github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= -github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU= +github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E= github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ= github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0= github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0= github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/crypto v0.0.0-20190911031432-227b76d455e7/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= -golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= -golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= -golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= -golang.org/x/crypto v0.45.0 h1:jMBrvKuj23MTlT0bQEOBcAE0mjg8mK9RXFhRH6nyF3Q= -golang.org/x/crypto v0.45.0/go.mod h1:XTGrrkGJve7CYK7J8PEww4aY7gM3qMCElcJQ8n8JdX4= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.yaml.in/yaml/v2 v2.4.3 h1:6gvOSjQoTB3vt1l+CU+tSyi/HOjfOjRLJ4YwYZGwRO0= +go.yaml.in/yaml/v2 v2.4.3/go.mod h1:zSxWcmIDjOzPXpjlTTbAsKokqkDNAVtZO0WOMiT90s8= +golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU= +golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0= golang.org/x/exp v0.0.0-20220827204233-334a2380cb91 h1:tnebWN09GYg9OLPss1KXj8txwZc6X6uMr6VFdcGNbHw= golang.org/x/exp v0.0.0-20220827204233-334a2380cb91/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE= -golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= -golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.29.0 h1:HV8lRxZC4l2cr3Zq1LvtOsi/ThTgWnUk/y64QSs8GwA= -golang.org/x/mod v0.29.0/go.mod h1:NyhrlYXJ2H4eJiRy/WDBO6HMqZQ6q9nk4JzS3NuCK+w= -golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= -golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= -golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU= -golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.3.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= -golang.org/x/net v0.4.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= -golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= -golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= -golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY= -golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU= -golang.org/x/oauth2 v0.3.0/go.mod h1:rQrIauxkUhJ6CuwEXwymO2/eh4xz2ZWF1nBkcxS+tGk= -golang.org/x/oauth2 v0.27.0 h1:da9Vo7/tDv5RH/7nZDz1eMGS/q1Vv1N/7FCrBhI9I3M= -golang.org/x/oauth2 v0.27.0/go.mod h1:onh5ek6nERTohokkhCD/y2cV4Do3fxFHFuAejCkRWT8= -golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I= -golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220412211240-33da011f77ad/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/mod v0.31.0 h1:HaW9xtz0+kOcWKwli0ZXy79Ix+UW/vOfmWI5QVd2tgI= +golang.org/x/mod v0.31.0/go.mod h1:43JraMp9cGx1Rx3AqioxrbrhNsLl2l/iNAvuBkrezpg= +golang.org/x/net v0.48.0 h1:zyQRTTrjc33Lhh0fBgT/H3oZq9WuvRR5gPC70xpDiQU= +golang.org/x/net v0.48.0/go.mod h1:+ndRgGjkh8FGtu1w1FGbEC31if4VrNVMuKTgcAAnQRY= +golang.org/x/oauth2 v0.34.0 h1:hqK/t4AKgbqWkdkcAeI8XLmbK+4m4G5YeQRrmiotGlw= +golang.org/x/oauth2 v0.34.0/go.mod h1:lzm5WQJQwKZ3nwavOZ3IS5Aulzxi68dUSgRHujetwEA= +golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4= +golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc= -golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= -golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8 h1:LvzTn0GQhWuvKH/kVRS3R3bVAsdQWI7hvfLHGgh9+lU= -golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8/go.mod h1:Pi4ztBfryZoJEkyFTI5/Ocsu2jXyDr6iSdgJiYE/uwE= -golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.0.0-20220526004731-065cf7ba2467/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= -golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= -golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= -golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= -golang.org/x/term v0.37.0 h1:8EGAD0qCmHYZg6J17DvsMy9/wJ7/D/4pV/wfnld5lTU= -golang.org/x/term v0.37.0/go.mod h1:5pB4lxRNYYVZuTLmy8oR2BH8dflOR+IbTYFD8fi3254= -golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= -golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= -golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= -golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= -golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM= -golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM= -golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= -golang.org/x/tools v0.1.11/go.mod h1:SgwaegtQh8clINPpECJMqnxLv9I09HLqnW3RMqW0CA4= -golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= -golang.org/x/tools v0.38.0 h1:Hx2Xv8hISq8Lm16jvBZ2VQf+RLmbd7wVUsALibYI/IQ= -golang.org/x/tools v0.38.0/go.mod h1:yEsQ/d/YK8cjh0L6rZlY8tgtlKiBNTL14pGDJPJpYQs= -golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20220609144429-65e65417b02f h1:uF6paiQQebLeSXkrTqHqz0MXhXXS1KgF41eUdBNvxK0= -golang.org/x/xerrors v0.0.0-20220609144429-65e65417b02f/go.mod h1:K8+ghG5WaK9qNqU5K3HdILfMLy1f3aNYFI/wnl100a8= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk= +golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/telemetry v0.0.0-20251215142616-e75fd47794af h1:JLNgZmN0uDGV+zlgKknvmvX9+atzn9b7S6M1L6J5tQs= +golang.org/x/telemetry v0.0.0-20251215142616-e75fd47794af/go.mod h1:ArQvPJS723nJQietgilmZA+shuB3CZxH1n2iXq9VSfs= +golang.org/x/term v0.38.0 h1:PQ5pkm/rLO6HnxFR7N2lJHOZX6Kez5Y1gDSJla6jo7Q= +golang.org/x/term v0.38.0/go.mod h1:bSEAKrOT1W+VSu9TSCMtoGEOUcKxOKgl3LE5QEF/xVg= +golang.org/x/text v0.32.0 h1:ZD01bjUt1FQ9WJ0ClOL5vxgxOI/sVCNgX1YtKwcY0mU= +golang.org/x/text v0.32.0/go.mod h1:o/rUWzghvpD5TXrTIBuJU77MTaN0ljMWE47kxGJQ7jY= +golang.org/x/time v0.13.0 h1:eUlYslOIt32DgYD6utsuUeHs4d7AsEYLuIAdg7FlYgI= +golang.org/x/time v0.13.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4= +golang.org/x/tools v0.40.0 h1:yLkxfA+Qnul4cs9QA3KnlFu0lVmd8JJfoq+E41uSutA= +golang.org/x/tools v0.40.0/go.mod h1:Ik/tzLRlbscWpqqMRjyWYDisX8bG13FrdXp3o4Sr9lc= +golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da h1:noIWHXmPHxILtqtCOPIhSt0ABwskkZKjD3bXGnZGpNY= +golang.org/x/xerrors v0.0.0-20240903120638-7835f813f4da/go.mod h1:NDW/Ps6MPRej6fsCIbMTohpP40sJ/P/vI1MoTEGwX90= gonum.org/v1/gonum v0.11.0 h1:f1IJhK4Km5tBJmaiJXtk/PkL4cdVX6J+tGiM187uT5E= gonum.org/v1/gonum v0.11.0/go.mod h1:fSG4YDCxxUZQJ7rKsQrj0gMOg00Il0Z96/qMA4bVQhA= -google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= -google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= -google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= -google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= -google.golang.org/protobuf v1.34.2 h1:6xV6lTsCfpGD21XK49h7MhtcApnLqkfYgPcdHftf6hg= -google.golang.org/protobuf v1.34.2/go.mod h1:qYOHts0dSfpeUzUFpOMr/WGzszTmLH+DiWniOlNbLDw= +google.golang.org/protobuf v1.36.10 h1:AYd7cD/uASjIL6Q9LiTjz8JLcrh/88q5UObnmY3aOOE= +google.golang.org/protobuf v1.36.10/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= -gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= -gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= -gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -gotest.tools/gotestsum v1.8.2 h1:szU3TaSz8wMx/uG+w/A2+4JUPwH903YYaMI9yOOYAyI= -gotest.tools/gotestsum v1.8.2/go.mod h1:6JHCiN6TEjA7Kaz23q1bH0e2Dc3YJjDUZ0DmctFZf+w= -gotest.tools/v3 v3.3.0 h1:MfDY1b1/0xN1CyMlQDac0ziEy9zJQd9CXBRRDHw2jJo= -gotest.tools/v3 v3.3.0/go.mod h1:Mcr9QNxkg0uMvy/YElmo4SpXgJKWgQvYrT7Kw5RzJ1A= +gotest.tools/gotestsum v1.13.0 h1:+Lh454O9mu9AMG1APV4o0y7oDYKyik/3kBOiCqiEpRo= +gotest.tools/gotestsum v1.13.0/go.mod h1:7f0NS5hFb0dWr4NtcsAsF0y1kzjEFfAil0HiBQJE03Q= +gotest.tools/v3 v3.5.2 h1:7koQfIKdy+I8UTetycgUqXWSDwpgv193Ka+qRsmBY8Q= +gotest.tools/v3 v3.5.2/go.mod h1:LtdLGcnqToBH83WByAAi/wiwSFCArdFIUV/xxN4pcjA= diff --git a/mixin/Makefile b/mixin/Makefile new file mode 100644 index 0000000..0546a1b --- /dev/null +++ b/mixin/Makefile @@ -0,0 +1,48 @@ +.PHONY: all clean build fmt lint install update + +JSONNET_FMT := jsonnetfmt -n 2 --max-blank-lines 2 --string-style s --comment-style s + +all: build dashboards_out prometheus_alerts.yaml + +vendor: jsonnetfile.json + jb install + +build: vendor + +fmt: + find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \ + xargs -n 1 -- $(JSONNET_FMT) -i + +lint: build + find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \ + while read f; do \ + $(JSONNET_FMT) "$$f" | diff -u "$$f" -; \ + done + mixtool lint mixin.libsonnet + +install: + jb install + +update: + jb update + +dashboards_out: mixin.libsonnet config.libsonnet + @mkdir -p dashboards_out + @echo "Generating dashboards..." + @if command -v mixtool >/dev/null 2>&1; then \ + mixtool generate dashboards mixin.libsonnet -d dashboards_out; \ + else \ + jsonnet -J vendor -m dashboards_out mixin.libsonnet; \ + fi + +prometheus_alerts.yaml: mixin.libsonnet alerts.jsonnet + @echo "Generating Prometheus alerts..." + @if command -v mixtool >/dev/null 2>&1; then \ + mixtool generate alerts mixin.libsonnet -a prometheus_alerts.yaml; \ + else \ + jsonnet -J vendor -S -y alerts.jsonnet > prometheus_alerts.yaml; \ + fi + +clean: + rm -rf dashboards_out prometheus_alerts.yaml + diff --git a/mixin/README.md b/mixin/README.md new file mode 100644 index 0000000..c77cd70 --- /dev/null +++ b/mixin/README.md @@ -0,0 +1,219 @@ +# Databricks mixin + +A set of Grafana dashboards and prometheus-compatible alerts for monitoring Databricks. + +The mixin follows the new monitoring [mixin design pattern](https://monitoring.mixins.dev/), using [jsonnet](https://jsonnet.org/) and [grafonnet](https://github.com/grafana/grafonnet) to generate dashboards and alerts. + +## Overview + +This mixin provides comprehensive monitoring for Databricks with three main personas in mind: + +1. **FinOps Persona** - Cost & Billing monitoring +2. **SRE/Platform Persona** - Jobs & Pipelines reliability +3. **Analytics/BI Persona** - SQL Warehouse performance + +### Key features + +- **Detailed drill-down**: All metrics include detailed labels (`job_id`, `job_name`, `pipeline_id`, `pipeline_name`, `task_key`, `warehouse_id`) enabling deep analysis of specific workloads +- **Multi-level views**: From high-level overview to detailed per-job/pipeline/warehouse breakdowns +- **Metrics**: Signals covering billing, jobs, pipelines, SQL queries and SQL warehouses +- **Alerts**: Tiered warning/critical alerts across all three personas +- **Sparse data handling**: Queries optimized for infrequent updates and sliding window metrics +- **Grafana variables**: Pre-configured filtering by job, workspace, and instance + +## Dashboards + +The mixin includes three main dashboards: + +### 1. Databricks overview +Executive summary dashboard showing: +- Total cost (30-day) and 24h growth % +- Total DBUs (30-day) consumption +- Global reliability metrics (jobs, pipelines, SQL success/error rates) +- Cost decomposition by SKU and workspace (tables) +- Failure trends over time + +### 2. Databricks jobs and pipelines +Deep dive into jobs and pipelines with drill-down capabilities: +- **Overview**: Runs, success rates, p95 duration stats +- **Throughput & Duration**: Total runs and p95 duration time series for jobs and pipelines +- **Reliability & Stability**: Failure rates and retries vs failures +- **Status Breakdowns**: Jobs and pipelines status over time +- **Jobs Drill-down**: Top jobs by runs/failures/duration, task retries, and time series by job name +- **Pipelines Drill-down**: Top pipelines by runs/failures/duration, freshness lag, and time series by pipeline name + +### 3. Databricks warehouses and queries +SQL warehouse performance and monitoring: +- **Overview**: Query totals (1h/24h), error rate, latency, concurrency metrics +- **Time Series**: Query load, latency (p50/p95), error rates, concurrency trends +- **Analysis**: Query volume by workspace +- **Top Warehouses**: Tables showing top warehouses by query count, errors, and latency +- **Warehouse Drill-down**: Queries, errors, latency, and concurrency by warehouse ID + +## Metrics + +The mixin expects metrics from the Databricks Prometheus exporter. For the complete list of metrics with descriptions, labels, and source tables, see the **[Metrics Reference](../docs/metrics-reference.md)**. + +**Summary:** +- **Billing**: DBUs, cost estimates, price changes (24h sliding window) +- **Jobs**: Run counts, durations, status, retries, SLA misses (4h sliding window) +- **Pipelines**: Run counts, durations, status, retries, freshness lag (4h sliding window) +- **SQL Queries**: Query counts, errors, durations, concurrency (2h sliding window) +- **Health**: Exporter connectivity, scrape status, build info + +## Alerts + +### FinOps persona alerts +- `DatabricksWarnSpendSpike` - 25% DoD cost increase +- `DatabricksCriticalSpendSpike` - 50% DoD cost increase +- `DatabricksWarnNoBillingData` - No billing data for 2 hours +- `DatabricksCriticalNoBillingData` - No billing data for 4 hours + +### SRE/platform persona alerts +- `DatabricksWarnJobFailureRate` - Job failure rate > 10% +- `DatabricksCriticalJobFailureRate` - Job failure rate > 20% +- `DatabricksWarnJobDurationRegression` - Job duration 30% above 7-day median +- `DatabricksCriticalJobDurationRegression` - Job duration 60% above 7-day median +- `DatabricksWarnPipelineFailureRate` - Pipeline failure rate > 10% +- `DatabricksCriticalPipelineFailureRate` - Pipeline failure rate > 20% +- `DatabricksWarnPipelineDurationRegression` - Pipeline duration 30% above 7-day median +- `DatabricksCritPipelineDurationHigh` - Pipeline duration 60% above 7-day median + +### Analytics/BI persona alerts +- `DatabricksWarnSqlQueryErrorRate` - SQL error rate > 5% +- `DatabricksCriticalSqlQueryErrorRate` - SQL error rate > 10% +- `DatabricksWarnSqlQueryLatencyRegression` - Query latency 30% above 7-day median +- `DatabricksCritQueryLatencyHigh` - Query latency 60% above 7-day median + +## Installation + +### Prerequisites +- [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler) (`jb`) +- [jsonnet](https://github.com/google/jsonnet) +- [mixtool](https://github.com/monitoring-mixins/mixtool) + +### Steps + +1. Install dependencies: +```bash +cd mixin +jb install +``` + +2. Build dashboards: +```bash +make dashboards_out +``` + +This will generate dashboard JSON files in the `dashboards_out/` directory: +- `databricks-overview.json` +- `databricks-jobs-and-pipelines.json` +- `databricks-warehouses-and-queries.json` + +3. Generate Prometheus alerts: +```bash +make prometheus_alerts.yaml +``` + +This will generate a `prometheus_alerts.yaml` file containing all alert rules. + +## Configuration + +### Scrape interval requirements + +The dashboards use `last_over_time(...[30m:])` to handle sparse data from infrequent scrapes. This requires: + +| Setting | Minimum | Maximum | +|---------|---------|---------| +| `scrape_interval` | 10m | 30m | +| `scrape_timeout` | 9m | 29m | + +See the main [README - Prometheus Configuration](../README.md#prometheus-configuration) for detailed configuration examples. + +### Mixin configuration + +The mixin can be configured via `config.libsonnet`. Key configuration options include: + +- `filteringSelector` - Prometheus label selector (default: `''`) +- `groupLabels` - Labels to group by (default: `['job', 'workspace_id']`) +- `dashboardRefresh` - Dashboard refresh interval (default: `1m`) +- `dashboardPeriod` - Default time range (default: `now-7d`) +- `dashboardTimezone` - Dashboard timezone (default: `utc`) +- Dashboard-specific settings for overview, jobs & pipelines, and warehouses & queries +- Alert thresholds and evaluation intervals + +## Development + +To modify the mixin: + +1. Edit the appropriate files: + - `signals/overview.libsonnet` - Overview dashboard metric definitions + - `signals/jobs_and_pipelines.libsonnet` - Jobs & Pipelines metric definitions + - `signals/warehouses_and_queries.libsonnet` - Warehouses & Queries metric definitions + - `panels.libsonnet` - Panel definitions + - `rows.libsonnet` - Row layouts + - `dashboards.libsonnet` - Dashboard definitions + - `alerts.libsonnet` - Alert rules + - `config.libsonnet` - Configuration options + +2. Format code: +```bash +make fmt +``` + +3. Lint: +```bash +make lint +``` + +4. Rebuild dashboards: +```bash +make dashboards_out +``` + +5. Generate Prometheus alerts: +```bash +make prometheus_alerts.yaml +``` + +## Known limitations + +### Pipeline metrics require permissions on `system.lakeflow.pipeline_update_timeline` + +**Affected metrics:** All `databricks_pipeline_*` metrics. See [Metrics reference](../docs/metrics-reference.md#pipeline-metrics) for the full list. + +**Issue:** The `system.lakeflow.pipeline_update_timeline` table exists but the Service Principal may not have `SELECT` permission on it. + +**Symptoms:** You'll see errors in the exporter logs (but only logged once, not repeatedly): +``` +TABLE_OR_VIEW_NOT_FOUND: The table or view `system`.`lakeflow`.`pipeline_update_timeline` cannot be found +``` + +**Impact:** +- Pipeline metrics will not be collected until permissions are granted +- Pipeline-related panels in the "Jobs & Pipelines" dashboard will show no data +- Pipeline-related alerts will not fire +- Other metrics (jobs, billing, queries) will continue to work normally +- **Automatic Recovery**: Once permissions are granted, the exporter automatically detects availability and resumes collection + +**Root Cause:** +The error message says "not found" but it's actually a **permissions issue**. The table exists in Databricks, but without proper permissions, it appears as if it doesn't exist. + +**Verification:** +Run this query in your Databricks SQL Warehouse: +```sql +SELECT COUNT(*) FROM system.lakeflow.pipeline_update_timeline LIMIT 1; +``` + +- If you get "TABLE_OR_VIEW_NOT_FOUND" → Permissions issue +- If you get a count → Permissions are correct + +**Solutions:** +1. **Grant Permissions**: Ensure all required Unity Catalog permissions are granted as described in the main [README - Required Permissions](../README.md#required-permissions) section +2. **Verify Schema Access**: Confirm the Service Principal has `USE SCHEMA` and `SELECT` permissions on `system.lakeflow` +3. **Wait for Auto-Recovery**: The exporter checks table availability periodically (every ~10 scrapes). Once permissions are granted, collection resumes automatically - no restart needed! + +## References + +- [Databricks System Tables](https://docs.databricks.com/admin/system-tables/) +- [Monitoring Mixins](https://monitoring.mixins.dev/) diff --git a/mixin/alerts.jsonnet b/mixin/alerts.jsonnet new file mode 100644 index 0000000..926afbd --- /dev/null +++ b/mixin/alerts.jsonnet @@ -0,0 +1,3 @@ +local mixin = import './mixin.libsonnet'; + +mixin.prometheusAlerts diff --git a/mixin/alerts.libsonnet b/mixin/alerts.libsonnet new file mode 100644 index 0000000..f10ecad --- /dev/null +++ b/mixin/alerts.libsonnet @@ -0,0 +1,323 @@ +{ + new(this): { + groups: [ + { + name: 'DatabricksAlerts', + rules: [ + { + alert: 'DatabricksWarnSpendSpike', + expr: ||| + ( + sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 1d) + - sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 2d) + ) + / sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 2d) + > (%(alertsSpendSpikeWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'Databricks spend increased significantly day-over-day.', + description: + ('Spending on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%%, ' + + 'which is above the warning threshold of %(alertsSpendSpikeWarning)s%%. Check cost drivers.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalSpendSpike', + expr: ||| + ( + sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 1d) + - sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 2d) + ) + / sum by (job, workspace_id) (databricks_billing_cost_estimate_usd_sliding{} offset 2d) + > (%(alertsSpendSpikeCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Databricks spend spiked critically day-over-day.', + description: + ('Spending on workspace {{$labels.workspace_id}} spiked by {{ printf "%%.0f" $value }}%%, ' + + 'which is above the critical threshold of %(alertsSpendSpikeCritical)s%%. Immediate investigation required.') % this.config, + }, + }, + { + alert: 'DatabricksWarnNoBillingData', + expr: ||| + (max_over_time(databricks_billing_dbus_sliding{}[6h]) > 0) + and + (increase(databricks_billing_dbus_sliding{}[%(alertsNoBillingDataWarningLookback)s]) == 0) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'No billing data received from Databricks.', + description: + ('No billing data has been received for workspace {{$labels.workspace_id}} in the last %(alertsNoBillingDataWarningLookback)s. ' + + 'Check SQL Warehouse status and system tables availability.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalNoBillingData', + expr: ||| + (max_over_time(databricks_billing_dbus_sliding{}[6h]) > 0) + and + (increase(databricks_billing_dbus_sliding{}[%(alertsNoBillingDataCriticalLookback)s]) == 0) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical: No billing data received from Databricks.', + description: + ('No billing data has been received for workspace {{$labels.workspace_id}} in the last %(alertsNoBillingDataCriticalLookback)s. ' + + 'Immediate investigation required - check SQL Warehouse and exporter status.') % this.config, + }, + }, + + // SRE / Platform Persona Alerts (Jobs) + { + alert: 'DatabricksWarnJobFailureRate', + expr: ||| + ( + sum by (job, workspace_id) (increase(databricks_job_run_status_sliding{status="FAILED"}[1h])) + / sum by (job, workspace_id) (increase(databricks_job_run_status_sliding{}[1h])) + ) > (%(alertsJobFailureRateWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'High job failure rate detected.', + description: + ('Job failure rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the warning threshold of %(alertsJobFailureRateWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalJobFailureRate', + expr: ||| + ( + sum by (job, workspace_id) (increase(databricks_job_run_status_sliding{status="FAILED"}[2h])) + / sum by (job, workspace_id) (increase(databricks_job_run_status_sliding{}[2h])) + ) > (%(alertsJobFailureRateCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical job failure rate detected.', + description: + ('Job failure rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the critical threshold of %(alertsJobFailureRateCritical)s%%. Investigate immediately.') % this.config, + }, + }, + { + alert: 'DatabricksWarnJobDurationRegression', + expr: ||| + ( + databricks_job_run_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_job_run_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsJobDurationRegressionWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'Job duration p95 regression detected.', + description: + ('Job p95 duration on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding warning threshold of %(alertsJobDurationRegressionWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalJobDurationRegression', + expr: ||| + ( + databricks_job_run_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_job_run_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsJobDurationRegressionCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical job duration p95 regression detected.', + description: + ('Job p95 duration on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding critical threshold of %(alertsJobDurationRegressionCritical)s%%.') % this.config, + }, + }, + + // SRE / Platform Persona Alerts (Pipelines) + { + alert: 'DatabricksWarnPipelineFailureRate', + expr: ||| + ( + sum by (job, workspace_id) (increase(databricks_pipeline_run_status_sliding{status="FAILED"}[1h])) + / sum by (job, workspace_id) (increase(databricks_pipeline_run_status_sliding{}[1h])) + ) > (%(alertsPipelineFailureRateWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'High pipeline failure rate detected.', + description: + ('Pipeline failure rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the warning threshold of %(alertsPipelineFailureRateWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalPipelineFailureRate', + expr: ||| + ( + sum by (job, workspace_id) (increase(databricks_pipeline_run_status_sliding{status="FAILED"}[1h])) + / sum by (job, workspace_id) (increase(databricks_pipeline_run_status_sliding{}[1h])) + ) > (%(alertsPipelineFailureRateCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical pipeline failure rate detected.', + description: + ('Pipeline failure rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the critical threshold of %(alertsPipelineFailureRateCritical)s%%. Investigate immediately.') % this.config, + }, + }, + { + alert: 'DatabricksWarnPipelineDurationRegression', + expr: ||| + ( + databricks_pipeline_run_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_pipeline_run_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsPipelineDurationRegressionWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'Pipeline duration p95 regression detected.', + description: + ('Pipeline p95 duration on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding warning threshold of %(alertsPipelineDurationRegressionWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCritPipelineDurationHigh', + expr: ||| + ( + databricks_pipeline_run_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_pipeline_run_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsPipelineDurationRegressionCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical pipeline duration p95 regression detected.', + description: + ('Pipeline p95 duration on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding critical threshold of %(alertsPipelineDurationRegressionCritical)s%%.') % this.config, + }, + }, + + // Analytics/BI Persona Alerts (SQL Warehouse) + { + alert: 'DatabricksWarnSqlQueryErrorRate', + expr: ||| + ( + sum by (job, workspace_id) (rate(databricks_query_errors_sliding{}[30m])) + / sum by (job, workspace_id) (rate(databricks_queries_sliding{}[30m])) + ) > (%(alertsSqlQueryErrorRateWarning)s / 100) + ||| % this.config, + 'for': '1h', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'High SQL query error rate detected.', + description: + ('SQL query error rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the warning threshold of %(alertsSqlQueryErrorRateWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCriticalSqlQueryErrorRate', + expr: ||| + ( + sum by (job, workspace_id) (rate(databricks_query_errors_sliding{}[30m])) + / sum by (job, workspace_id) (rate(databricks_queries_sliding{}[30m])) + ) > (%(alertsSqlQueryErrorRateCritical)s / 100) + ||| % this.config, + 'for': '1h', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical SQL query error rate detected.', + description: + ('SQL query error rate on workspace {{$labels.workspace_id}} is {{ printf "%%.1f" $value }}%%, ' + + 'which exceeds the critical threshold of %(alertsSqlQueryErrorRateCritical)s%%. Investigate immediately.') % this.config, + }, + }, + { + alert: 'DatabricksWarnSqlQueryLatencyRegression', + expr: ||| + ( + databricks_query_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_query_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsSqlQueryLatencyRegressionWarning)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'warning', + }, + annotations: { + summary: 'SQL query latency p95 regression detected.', + description: + ('SQL query p95 latency on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding warning threshold of %(alertsSqlQueryLatencyRegressionWarning)s%%.') % this.config, + }, + }, + { + alert: 'DatabricksCritQueryLatencyHigh', + expr: ||| + ( + databricks_query_duration_seconds_sliding{quantile="0.95"} + / quantile_over_time(0.5, databricks_query_duration_seconds_sliding{quantile="0.95"}[7d]) + ) - 1 > (%(alertsSqlQueryLatencyRegressionCritical)s / 100) + ||| % this.config, + 'for': '5m', + labels: { + severity: 'critical', + }, + annotations: { + summary: 'Critical SQL query latency p95 regression detected.', + description: + ('SQL query p95 latency on workspace {{$labels.workspace_id}} increased by {{ printf "%%.0f" $value }}%% ' + + 'compared to 7-day median, exceeding critical threshold of %(alertsSqlQueryLatencyRegressionCritical)s%%.') % this.config, + }, + }, + ], + }, + ], + }, +} diff --git a/mixin/config.libsonnet b/mixin/config.libsonnet new file mode 100644 index 0000000..91a19c0 --- /dev/null +++ b/mixin/config.libsonnet @@ -0,0 +1,46 @@ +{ + local this = self, + filteringSelector: '', + // NOTE: 'job' is the Prometheus scrape job label (NOT Databricks jobs). + // Required by mixtool lint. Users with multiple exporters can filter by job. + groupLabels: ['job', 'workspace_id'], + uid: 'databricks', + instanceLabels: ['instance'], + enableLokiLogs: false, + + // dashboard config + dashboardTags: [this.uid + '-mixin'], + dashboardNamePrefix: 'Databricks', + dashboardPeriod: 'now-1h', + dashboardTimezone: 'default', + dashboardRefresh: '30s', + metricsSource: 'prometheus', + + // for alerts - Finance Persona + alertsSpendSpikeWarning: '25', // % DoD increase + alertsSpendSpikeCritical: '50', // % DoD increase + alertsNoBillingDataWarningLookback: '2h', + alertsNoBillingDataCriticalLookback: '4h', + + // for alerts - SRE / Platform Persona (Jobs & Pipelines) + alertsJobFailureRateWarning: '10', // % + alertsJobFailureRateCritical: '20', // % + alertsPipelineFailureRateWarning: '10', // % + alertsPipelineFailureRateCritical: '20', // % + alertsJobDurationRegressionWarning: '30', // % vs 7-day median + alertsJobDurationRegressionCritical: '60', // % vs 7-day median + alertsPipelineDurationRegressionWarning: '30', // % vs 7-day median + alertsPipelineDurationRegressionCritical: '60', // % vs 7-day median + + // for alerts - Analytics/BI Persona (SQL Warehouse) + alertsSqlQueryErrorRateWarning: '5', // % + alertsSqlQueryErrorRateCritical: '10', // % + alertsSqlQueryLatencyRegressionWarning: '30', // % vs 7-day median + alertsSqlQueryLatencyRegressionCritical: '60', // % vs 7-day median + + signals+: { + overview: (import './signals/overview.libsonnet')(this), + jobsAndPipelines: (import './signals/jobs_and_pipelines.libsonnet')(this), + warehousesAndQueries: (import './signals/warehouses_and_queries.libsonnet')(this), + }, +} diff --git a/mixin/dashboards.libsonnet b/mixin/dashboards.libsonnet new file mode 100644 index 0000000..6d8f747 --- /dev/null +++ b/mixin/dashboards.libsonnet @@ -0,0 +1,106 @@ +local g = import './g.libsonnet'; +local commonlib = import 'common-lib/common/main.libsonnet'; + +{ + local root = self, + new(this):: + local prefix = this.config.dashboardNamePrefix; + local links = this.grafana.links; + local tags = this.config.dashboardTags; + local uid = g.util.string.slugify(this.config.uid); + local vars = this.grafana.variables; + local annotations = this.grafana.annotations; + local refresh = this.config.dashboardRefresh; + local period = this.config.dashboardPeriod; + local timezone = this.config.dashboardTimezone; + { + 'databricks-overview.json': + g.dashboard.new(prefix + ' Overview') + + g.dashboard.withDescription('Executive summary dashboard showing costs, billing, and overall reliability metrics for Databricks.') + + g.dashboard.withPanels( + g.util.panel.resolveCollapsedFlagOnRows( + g.util.grid.wrapPanels( + [ + this.grafana.rows.overviewStatistics, + this.grafana.rows.overviewCharts, + this.grafana.rows.overviewDecomposition, + this.grafana.rows.overviewTrends, + ] + ) + ) + ) + root.applyCommon( + vars.multiInstance, + uid + '_overview', + tags, + links { databricksOverview:: {} }, + annotations, + timezone, + refresh, + period, + ), + + 'databricks-jobs-and-pipelines.json': + g.dashboard.new(prefix + ' Jobs & Pipelines') + + g.dashboard.withDescription('Deep dive into jobs and pipelines reliability, throughput, and performance metrics.') + + g.dashboard.withPanels( + g.util.panel.resolveCollapsedFlagOnRows( + g.util.grid.wrapPanels( + [ + this.grafana.rows.workloadsStatistics, + this.grafana.rows.workloadsThroughput, + this.grafana.rows.workloadsReliability, + this.grafana.rows.workloadsStatusBreakdown, + this.grafana.rows.workloadsJobDrilldown, + this.grafana.rows.workloadsPipelineDrilldown, + ] + ) + ) + ) + root.applyCommon( + vars.multiInstance, + uid + '_jobs_pipelines', + tags, + links { databricksJobsPipelines:: {} }, + annotations, + timezone, + refresh, + period, + ), + + 'databricks-warehouses-and-queries.json': + g.dashboard.new(prefix + ' Warehouses & Queries') + + g.dashboard.withDescription('Comprehensive view of SQL warehouse performance, query latency, errors, and concurrency.') + + g.dashboard.withPanels( + g.util.panel.resolveCollapsedFlagOnRows( + g.util.grid.wrapPanels( + [ + this.grafana.rows.sqlbiStatistics, + this.grafana.rows.sqlbiLoadAndLatency, + this.grafana.rows.sqlbiErrorsAndConcurrency, + this.grafana.rows.sqlbiTopWarehouses, + this.grafana.rows.sqlbiDistribution, + this.grafana.rows.sqlbiWarehouseDrilldown, + ] + ) + ) + ) + root.applyCommon( + vars.multiInstance, + uid + '_warehouses_queries', + tags, + links { databricksWarehousesQueries:: {} }, + annotations, + timezone, + refresh, + period, + ), + }, + applyCommon(vars, uid, tags, links, annotations, timezone, refresh, period): + g.dashboard.withTags(tags) + + g.dashboard.withUid(uid) + + g.dashboard.withLinks(std.objectValues(links)) + + g.dashboard.withTimezone(timezone) + + g.dashboard.withRefresh(refresh) + + g.dashboard.time.withFrom(period) + + g.dashboard.withVariables(vars) + + g.dashboard.withAnnotations(std.objectValues(annotations)), + +} diff --git a/mixin/dashboards_out/databricks-jobs-and-pipelines.json b/mixin/dashboards_out/databricks-jobs-and-pipelines.json new file mode 100644 index 0000000..8916ed7 --- /dev/null +++ b/mixin/dashboards_out/databricks-jobs-and-pipelines.json @@ -0,0 +1,1669 @@ +{ + "annotations": { + "list": [ ] + }, + "description": "Deep dive into jobs and pipelines reliability, throughput, and performance metrics.", + "links": [ + { + "includeVars": true, + "keepTime": true, + "title": "Overview", + "type": "link", + "url": "/d/databricks_overview/databricks-overview" + }, + { + "includeVars": true, + "keepTime": true, + "title": "Warehouses & Queries", + "type": "link", + "url": "/d/databricks_warehouses_queries/databricks-warehouses-and-queries" + } + ], + "panels": [ + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 0 + }, + "id": 1, + "panels": [ ], + "title": "Workloads overview", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job runs (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 0, + "y": 1 + }, + "id": 2, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_job_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Jobs", + "refId": "Jobs throughput" + } + ], + "title": "Job runs", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipeline runs (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 4, + "y": 1 + }, + "id": 3, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_pipeline_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Pipelines", + "refId": "Pipelines throughput" + } + ], + "title": "Pipeline runs", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Percentage of successful jobs (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 8, + "y": 1 + }, + "id": 4, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"SUCCEEDED\"})\n /\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Success rate", + "refId": "Job success rate" + } + ], + "title": "Job success %", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Percentage of successful pipelines (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 12, + "y": 1 + }, + "id": 5, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"COMPLETED\"})\n /\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Success rate", + "refId": "Pipeline success rate" + } + ], + "title": "Pipeline success %", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum p95 job duration across all jobs.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 16, + "y": 1 + }, + "id": 6, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_job_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Jobs p95", + "refId": "Job run p95 duration (aggregate)" + } + ], + "title": "Job p95 duration (max)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum p95 pipeline duration across all pipelines.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 20, + "y": 1 + }, + "id": 7, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_pipeline_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Pipelines p95", + "refId": "Pipeline run p95 duration (aggregate)" + } + ], + "title": "Pipeline p95 duration (max)", + "type": "stat" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 5 + }, + "id": 8, + "panels": [ ], + "title": "Throughput & duration", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Number of job and pipeline runs (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 6 + }, + "id": 9, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_job_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Jobs", + "refId": "Jobs throughput" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_pipeline_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Pipelines", + "refId": "Pipelines throughput" + } + ], + "title": "Total runs", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum p95 duration across all jobs over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 6 + }, + "id": 10, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list", + "placement": "bottom" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_job_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Jobs p95", + "refId": "Job run p95 duration (aggregate)" + } + ], + "title": "Job p95 duration", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum p95 duration across all pipelines over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 6 + }, + "id": 11, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list", + "placement": "bottom" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_pipeline_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Pipelines p95", + "refId": "Pipeline run p95 duration (aggregate)" + } + ], + "title": "Pipeline p95 duration", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 14 + }, + "id": 12, + "panels": [ ], + "title": "Reliability & stability", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job and pipeline failure rates by workspace (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 15 + }, + "id": 13, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (workspace_id) (databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=~\"FAILED|ERROR\"})\n /\n sum by (workspace_id) (databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Jobs", + "refId": "Job failure rate" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (workspace_id) (databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"FAILED\"})\n /\n sum by (workspace_id) (databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Pipelines", + "refId": "Pipeline failure rate" + } + ], + "title": "Failure rate by workspace", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Number of task and pipeline retries (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 15 + }, + "id": 14, + "options": { + "legend": { + "asTable": true, + "calcs": [ ], + "displayMode": "list", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_task_retries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Task retries", + "refId": "Task retries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_retry_events_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Pipeline retries", + "refId": "Pipeline retries" + } + ], + "title": "Retries", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 23 + }, + "id": 15, + "panels": [ ], + "title": "Status breakdown", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job status breakdown showing counts (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never", + "stacking": { + "mode": "normal" + } + }, + "unit": "short" + } + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 0, + "y": 24 + }, + "id": 16, + "options": { + "legend": { + "asTable": true, + "calcs": [ ], + "displayMode": "list", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{job_name}} - {{status}}", + "refId": "Job status breakdown" + } + ], + "title": "Jobs status breakdown", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipeline status breakdown showing counts (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never", + "stacking": { + "mode": "normal" + } + }, + "unit": "short" + } + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 12, + "y": 24 + }, + "id": 17, + "options": { + "legend": { + "asTable": true, + "calcs": [ ], + "displayMode": "list", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{pipeline_name}} - {{status}}", + "refId": "Pipeline status breakdown" + } + ], + "title": "Pipelines status breakdown", + "type": "timeseries" + }, + { + "collapsed": true, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 34 + }, + "id": 18, + "panels": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Jobs with most runs (all time).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Runs" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 35 + }, + "id": 19, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id, job_id, job_name) (databricks_job_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{job_name}}", + "refId": "Top jobs by runs (table)" + } + ], + "title": "Top jobs by runs", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 3, + "job_id": 1, + "job_name": 2, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Total Runs", + "job_id": "Job ID", + "job_name": "Job Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Runs" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Jobs with longest p95 duration.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "p95 Duration (seconds)" + }, + "properties": [ + { + "id": "unit", + "value": "s" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 35 + }, + "id": 20, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_job_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{job_name}} (p95)", + "refId": "Job duration by job name" + } + ], + "title": "Top jobs by p95 duration", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true, + "quantile": true + }, + "indexByName": { + "Value": 3, + "job_id": 1, + "job_name": 2, + "workspace_id": 0 + }, + "renameByName": { + "Value": "p95 Duration (seconds)", + "job_id": "Job ID", + "job_name": "Job Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "p95 Duration (seconds)" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Jobs with most failures (adapts to dashboard time range).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Failures" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 35 + }, + "id": 21, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=~\"ERROR|FAILED|CANCELLED\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{job_name}}", + "refId": "Job failures by job name" + } + ], + "title": "Top jobs by failures", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 4, + "job_id": 1, + "job_name": 2, + "status": 3, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Total Failures", + "job_id": "Job ID", + "job_name": "Job Name", + "status": "Status", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Failures" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job run counts over time by job name (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 0, + "y": 45 + }, + "id": 22, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "table", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_job_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{job_name}}", + "refId": "Job runs by name (chart)" + } + ], + "title": "Job runs by name", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job p95 duration over time by job name.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 10, + "w": 12, + "x": 12, + "y": 45 + }, + "id": 23, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "table", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_job_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{job_name}} (p95)", + "refId": "Job duration by job name" + } + ], + "title": "Job p95 duration by name", + "type": "timeseries" + } + ], + "title": "Jobs drill-down (by job name)", + "type": "row" + }, + { + "collapsed": true, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 55 + }, + "id": 24, + "panels": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipeline run counts over time by pipeline name (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 10, + "w": 24, + "x": 0, + "y": 56 + }, + "id": 25, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "table", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{pipeline_name}}", + "refId": "Pipeline runs by name (chart)" + } + ], + "title": "Pipeline runs by name", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipelines with most runs (all time).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Runs" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 64 + }, + "id": 26, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id, pipeline_id, pipeline_name) (databricks_pipeline_runs_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{pipeline_name}}", + "refId": "Top pipelines by runs (table)" + } + ], + "title": "Top pipelines by runs", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 3, + "pipeline_id": 1, + "pipeline_name": 2, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Total Runs", + "pipeline_id": "Pipeline ID", + "pipeline_name": "Pipeline Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Runs" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipelines with longest p95 duration.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "p95 Duration (seconds)" + }, + "properties": [ + { + "id": "unit", + "value": "s" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 64 + }, + "id": 27, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{pipeline_name}} (p95)", + "refId": "Pipeline duration by pipeline name" + } + ], + "title": "Top pipelines by p95 duration", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true, + "quantile": true + }, + "indexByName": { + "Value": 3, + "pipeline_id": 1, + "pipeline_name": 2, + "workspace_id": 0 + }, + "renameByName": { + "Value": "p95 Duration (seconds)", + "pipeline_id": "Pipeline ID", + "pipeline_name": "Pipeline Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "p95 Duration (seconds)" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipelines with most failures (adapts to dashboard time range).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Failures" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 64 + }, + "id": 28, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"FAILED\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{pipeline_name}}", + "refId": "Pipeline failures by pipeline name" + } + ], + "title": "Top pipelines by failures", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 4, + "pipeline_id": 1, + "pipeline_name": 2, + "status": 3, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Total Failures", + "pipeline_id": "Pipeline ID", + "pipeline_name": "Pipeline Name", + "status": "Status", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Failures" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Data freshness lag by pipeline.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Freshness Lag (seconds)" + }, + "properties": [ + { + "id": "unit", + "value": "s" + } + ] + } + ] + }, + "gridPos": { + "h": 10, + "w": 10, + "x": 0, + "y": 74 + }, + "id": 29, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_freshness_lag_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{pipeline_name}}", + "refId": "Pipeline freshness lag by pipeline name" + } + ], + "title": "Pipeline freshness lag", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 3, + "pipeline_id": 1, + "pipeline_name": 2, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Freshness Lag (seconds)", + "pipeline_id": "Pipeline ID", + "pipeline_name": "Pipeline Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Freshness Lag (seconds)" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipeline p95 duration over time by pipeline name.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 10, + "w": 14, + "x": 10, + "y": 74 + }, + "id": 30, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "table", + "placement": "right" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_pipeline_run_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{pipeline_name}} (p95)", + "refId": "Pipeline duration by pipeline name" + } + ], + "title": "Pipeline p95 duration by name", + "type": "timeseries" + } + ], + "title": "Pipelines drill-down (by pipeline name)", + "type": "row" + } + ], + "refresh": "30s", + "schemaVersion": 39, + "tags": [ + "databricks-mixin" + ], + "templating": { + "list": [ + { + "label": "Data source", + "name": "datasource", + "query": "prometheus", + "regex": "", + "type": "datasource" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Job", + "multi": true, + "name": "job", + "query": "label_values(databricks_billing_dbus_sliding{}, job)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".*", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Workspace", + "multi": true, + "name": "workspace_id", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\"}, workspace_id)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Instance", + "multi": true, + "name": "instance", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\"}, instance)", + "refresh": 2, + "sort": 1, + "type": "query" + } + ] + }, + "time": { + "from": "now-1h", + "to": "now" + }, + "timezone": "default", + "title": "Databricks Jobs & Pipelines", + "uid": "databricks_jobs_pipelines" + } \ No newline at end of file diff --git a/mixin/dashboards_out/databricks-overview.json b/mixin/dashboards_out/databricks-overview.json new file mode 100644 index 0000000..acc2892 --- /dev/null +++ b/mixin/dashboards_out/databricks-overview.json @@ -0,0 +1,1061 @@ +{ + "annotations": { + "list": [ ] + }, + "description": "Executive summary dashboard showing costs, billing, and overall reliability metrics for Databricks.", + "links": [ + { + "includeVars": true, + "keepTime": true, + "title": "Jobs & Pipelines", + "type": "link", + "url": "/d/databricks_jobs_pipelines/databricks-jobs-and-pipelines" + }, + { + "includeVars": true, + "keepTime": true, + "title": "Warehouses & Queries", + "type": "link", + "url": "/d/databricks_warehouses_queries/databricks-warehouses-and-queries" + } + ], + "panels": [ + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 0 + }, + "id": 1, + "panels": [ ], + "title": "Overview", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Total cost estimate for the past 24 hours. This is a rolling 1-day window from exporter.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "decimals": 2, + "unit": "currencyUSD" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 0, + "y": 1 + }, + "id": 2, + "options": { + "graphMode": "none", + "textMode": "value" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "sum(databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})", + "format": "time_series", + "instant": false, + "legendFormat": "Cost", + "refId": "Total cost (24h window)" + } + ], + "title": "Total cost (24h window)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Percentage change comparing current 24h window to the 24h window from yesterday. Green = low growth, Yellow = moderate growth (>15%), Red = high growth (>25%).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "decimals": 1, + "thresholds": { + "steps": [ + { + "color": "green" + }, + { + "color": "yellow", + "value": 0.14999999999999999 + }, + { + "color": "red", + "value": 0.25 + } + ] + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 4, + "y": 1 + }, + "id": 3, + "options": { + "graphMode": "none", + "textMode": "value" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "(\n sum(databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n - \n sum(databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 24h)\n)\n/\nsum(databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 24h)\n", + "format": "time_series", + "instant": false, + "legendFormat": "24h change", + "refId": "Cost change (vs 24h ago)" + } + ], + "title": "Cost change % (previous 24h)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Total DBUs consumed over the past 24 hours. This is a rolling 1-day window from the exporter.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 8, + "y": 1 + }, + "id": 4, + "options": { + "graphMode": "none", + "textMode": "value" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "sum(databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})", + "format": "time_series", + "instant": false, + "legendFormat": "DBUs", + "refId": "Total DBUs (24h window)" + } + ], + "title": "Total DBUs (24h window)", + "type": "stat" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Mixed --" + }, + "description": "Percentage of successful jobs (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "max": 1, + "min": 0, + "thresholds": { + "steps": [ + { + "color": "red" + }, + { + "color": "yellow", + "value": 0.80000000000000004 + }, + { + "color": "green", + "value": 0.90000000000000002 + } + ] + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 12, + "y": 1 + }, + "id": 5, + "options": { + "showThresholdLabels": false, + "showThresholdMarkers": true + }, + "pluginVersion": "v11.4.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"SUCCEEDED\"})\n /\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Success rate", + "refId": "Job success rate" + } + ], + "title": "Jobs success %", + "type": "gauge" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Mixed --" + }, + "description": "Percentage of successful pipelines (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "max": 1, + "min": 0, + "thresholds": { + "steps": [ + { + "color": "red" + }, + { + "color": "yellow", + "value": 0.80000000000000004 + }, + { + "color": "green", + "value": 0.90000000000000002 + } + ] + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 16, + "y": 1 + }, + "id": 6, + "options": { + "showThresholdLabels": false, + "showThresholdMarkers": true + }, + "pluginVersion": "v11.4.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"COMPLETED\"})\n /\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Success rate", + "refId": "Pipeline success rate" + } + ], + "title": "Pipelines success %", + "type": "gauge" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Mixed --" + }, + "description": "SQL query error percentage (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "max": 0.20000000000000001, + "min": 0, + "thresholds": { + "steps": [ + { + "color": "green" + }, + { + "color": "yellow", + "value": 0.050000000000000003 + }, + { + "color": "red", + "value": 0.10000000000000001 + } + ] + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 20, + "y": 1 + }, + "id": 7, + "options": { + "showThresholdLabels": false, + "showThresholdMarkers": true + }, + "pluginVersion": "v11.4.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum(databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Error rate %", + "refId": "Query error rate (aggregate)" + } + ], + "title": "SQL error %", + "type": "gauge" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 5 + }, + "id": 8, + "panels": [ ], + "title": "Cost & reliability trends", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Cost breakdown by SKU over time (24h rolling window from exporter).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "currencyUSD" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 6 + }, + "id": 9, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{sku_name}}", + "refId": "Cost by SKU" + } + ], + "title": "Cost by SKU", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Cost efficiency metric - shows how much each DBU costs for each SKU. Lower is more cost-efficient (24h rolling window).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "currencyUSD" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 6 + }, + "id": 10, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list", + "placement": "bottom", + "showLegend": true + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum by (sku_name) (databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{sku_name}}", + "refId": "Cost per DBU by SKU" + } + ], + "title": "Cost per DBU by SKU", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Jobs and pipelines success rate (%) and SQL error rate (%) overlay.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 6 + }, + "id": 11, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"SUCCEEDED\"})\n /\n sum(databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Jobs success rate", + "refId": "Job success rate" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"COMPLETED\"})\n /\n sum(databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Pipelines success rate", + "refId": "Pipeline success rate" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (job,workspace_id,instance) (databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Query errors rate", + "refId": "Query error rate" + } + ], + "title": "Global reliability", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 14 + }, + "id": 12, + "panels": [ ], + "title": "Cost decomposition", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Workspaces with highest costs (24h rolling window from exporter).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Cost" + }, + "properties": [ + { + "id": "unit", + "value": "currencyUSD" + }, + { + "id": "decimals", + "value": 2 + } + ] + } + ] + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 0, + "y": 15 + }, + "id": 13, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id) (databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{workspace_id}}", + "refId": "Top workspaces by cost (24h window)" + } + ], + "title": "Top workspaces by cost", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 1, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Cost", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Cost" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "SKUs with highest costs (24h rolling window from exporter).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Cost" + }, + "properties": [ + { + "id": "unit", + "value": "currencyUSD" + }, + { + "id": "decimals", + "value": 2 + } + ] + } + ] + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 8, + "y": 15 + }, + "id": 14, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{sku_name}}", + "refId": "Top SKUs by cost (24h window)" + } + ], + "title": "Top SKUs by cost", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 2, + "sku_name": 1, + "workspace_id": 0 + }, + "renameByName": { + "Value": "Total Cost", + "sku_name": "SKU Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Cost" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "DBUs consumed broken down by workspace and SKU (24h rolling window from exporter).", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "DBUs" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 16, + "y": 15 + }, + "id": 15, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{workspace_id}} - {{sku_name}}", + "refId": "Billing DBUs total" + } + ], + "title": "DBUs by workspace and SKU", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 2, + "sku_name": 1, + "workspace_id": 0 + }, + "renameByName": { + "Value": "DBUs", + "sku_name": "SKU Name", + "workspace_id": "Workspace ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "DBUs" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 21 + }, + "id": 16, + "panels": [ ], + "title": "Reliability trends", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Job failure rate over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "noValue": "0", + "unit": "percentunit" + } + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 0, + "y": 22 + }, + "id": 17, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (workspace_id) (databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=~\"FAILED|ERROR\"})\n /\n sum by (workspace_id) (databricks_job_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Jobs", + "refId": "Job failure rate" + } + ], + "title": "Jobs failure trend", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Pipeline failure rate over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "noValue": "0", + "unit": "percentunit" + } + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 8, + "y": 22 + }, + "id": 18, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (workspace_id) (databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", status=\"FAILED\"})\n /\n sum by (workspace_id) (databricks_pipeline_run_status_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Pipelines", + "refId": "Pipeline failure rate" + } + ], + "title": "Pipelines failure trend", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "SQL query error rate over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "noValue": "0", + "unit": "percentunit" + } + }, + "gridPos": { + "h": 6, + "w": 8, + "x": 16, + "y": 22 + }, + "id": 19, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (job,workspace_id,instance) (databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Error rate %", + "refId": "Query error rate" + } + ], + "title": "SQL error trend", + "type": "timeseries" + } + ], + "refresh": "30s", + "schemaVersion": 39, + "tags": [ + "databricks-mixin" + ], + "templating": { + "list": [ + { + "label": "Data source", + "name": "datasource", + "query": "prometheus", + "regex": "", + "type": "datasource" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Job", + "multi": true, + "name": "job", + "query": "label_values(databricks_billing_dbus_sliding{}, job)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".*", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Workspace", + "multi": true, + "name": "workspace_id", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\"}, workspace_id)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Instance", + "multi": true, + "name": "instance", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\"}, instance)", + "refresh": 2, + "sort": 1, + "type": "query" + } + ] + }, + "time": { + "from": "now-1h", + "to": "now" + }, + "timezone": "default", + "title": "Databricks Overview", + "uid": "databricks_overview" + } \ No newline at end of file diff --git a/mixin/dashboards_out/databricks-warehouses-and-queries.json b/mixin/dashboards_out/databricks-warehouses-and-queries.json new file mode 100644 index 0000000..185c580 --- /dev/null +++ b/mixin/dashboards_out/databricks-warehouses-and-queries.json @@ -0,0 +1,1378 @@ +{ + "annotations": { + "list": [ ] + }, + "description": "Comprehensive view of SQL warehouse performance, query latency, errors, and concurrency.", + "links": [ + { + "includeVars": true, + "keepTime": true, + "title": "Jobs & Pipelines", + "type": "link", + "url": "/d/databricks_jobs_pipelines/databricks-jobs-and-pipelines" + }, + { + "includeVars": true, + "keepTime": true, + "title": "Overview", + "type": "link", + "url": "/d/databricks_overview/databricks-overview" + } + ], + "panels": [ + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 0 + }, + "id": 1, + "panels": [ ], + "title": "SQL warehouse overview", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Total queries executed (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 3, + "x": 0, + "y": 1 + }, + "id": 2, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Queries", + "refId": "Query load" + } + ], + "title": "Total queries", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Error percentage (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 3, + "x": 3, + "y": 1 + }, + "id": 3, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum(databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Error rate %", + "refId": "Query error rate (aggregate)" + } + ], + "title": "Query error %", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum p95 query latency across all warehouses.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 4, + "w": 3, + "x": 6, + "y": 1 + }, + "id": 4, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "p95 latency", + "refId": "Query p95 latency (max)" + } + ], + "title": "p95 latency (max)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum concurrent queries across all warehouses.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 3, + "x": 9, + "y": 1 + }, + "id": 5, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_queries_running_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Total queries running", + "refId": "Total queries running (max)" + } + ], + "title": "Max concurrent queries (now)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Maximum baseline concurrency over 7 days (p95).", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 12, + "y": 1 + }, + "id": 6, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "max(quantile_over_time(0.95, databricks_queries_running_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}[7d]))", + "format": "time_series", + "instant": false, + "legendFormat": "7d baseline", + "refId": "Max concurrent queries (7d p95)" + } + ], + "title": "Max concurrent queries (7d p95)", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Day-over-day query count change.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 16, + "y": 1 + }, + "id": 7, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n (\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 1d)\n -\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 2d)\n )\n /\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 2d)\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "DoD", + "refId": "DoD queries delta" + } + ], + "title": "DoD queries diff %", + "type": "stat" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Day-over-day p95 latency change.", + "fieldConfig": { + "defaults": { + "color": { + "fixedColor": "text", + "mode": "fixed" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 4, + "w": 4, + "x": 20, + "y": 1 + }, + "id": 8, + "options": { + "graphMode": "none" + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "max(\n (\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 1d)\n -\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 2d)\n )\n /\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 2d)\n)\n", + "format": "time_series", + "instant": false, + "legendFormat": "DoD p95 (max)", + "refId": "DoD p95 latency delta (max)" + } + ], + "title": "DoD p95 latency diff %", + "type": "stat" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 5 + }, + "id": 9, + "panels": [ ], + "title": "Load & latency", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query execution rate over time.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 0, + "y": 6 + }, + "id": 10, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Queries", + "refId": "Query load" + } + ], + "title": "Query load (rate)", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query latency: p50 vs. p95.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 12, + "x": 12, + "y": 6 + }, + "id": 11, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.50\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Current p50", + "refId": "Query p50 latency (max)" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "p95 latency", + "refId": "Query p95 latency (max)" + } + ], + "title": "Query latency: p50 vs. p95", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 14 + }, + "id": 12, + "panels": [ ], + "title": "Errors, concurrency & workspace distribution", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "SQL error rate with warn/crit bands.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 15 + }, + "id": 13, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum by (job,workspace_id,instance) (databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}} - Error rate %", + "refId": "Query error rate" + } + ], + "title": "SQL error rate", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Overlay showing saturation effect.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 15 + }, + "id": 14, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_queries_running_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Total queries running", + "refId": "Total queries running (max)" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "p95 latency", + "refId": "Query p95 latency (max)" + } + ], + "title": "Concurrency vs latency", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query volume by workspace.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 15 + }, + "id": 15, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{workspace_id}}", + "refId": "Queries by workspace" + } + ], + "title": "Queries by workspace", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 23 + }, + "id": 16, + "panels": [ ], + "title": "Top warehouses", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Warehouses ranked by total query volume.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Queries" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 24 + }, + "id": 17, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id, warehouse_id) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{warehouse_id}}", + "refId": "Top warehouses by queries" + } + ], + "title": "Top warehouses by queries", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 1, + "warehouse_id": 0 + }, + "renameByName": { + "Value": "Total Queries", + "warehouse_id": "Warehouse ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Queries" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Warehouses ranked by total error count.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "Total Errors" + }, + "properties": [ + { + "id": "unit", + "value": "short" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 24 + }, + "id": 18, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n sum by (workspace_id, warehouse_id) (databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{warehouse_id}}", + "refId": "Top warehouses by errors" + } + ], + "title": "Top warehouses by errors", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 1, + "warehouse_id": 0 + }, + "renameByName": { + "Value": "Total Errors", + "warehouse_id": "Warehouse ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "Total Errors" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Warehouses ranked by highest p95 latency.", + "fieldConfig": { + "overrides": [ + { + "matcher": { + "id": "byName", + "options": "p95 Latency (seconds)" + }, + "properties": [ + { + "id": "unit", + "value": "s" + } + ] + } + ] + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 24 + }, + "id": 19, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max by (warehouse_id) (databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "table", + "instant": true, + "legendFormat": "{{warehouse_id}}", + "refId": "Top warehouses by p95 latency" + } + ], + "title": "Top warehouses by p95 latency", + "transformations": [ + { + "id": "organize", + "options": { + "excludeByName": { + "Time": true, + "__name__": true, + "instance": true, + "job": true + }, + "indexByName": { + "Value": 1, + "warehouse_id": 0 + }, + "renameByName": { + "Value": "p95 Latency (seconds)", + "warehouse_id": "Warehouse ID" + } + } + }, + { + "id": "sortBy", + "options": { + "sort": [ + { + "desc": true, + "field": "p95 Latency (seconds)" + } + ] + } + }, + { + "id": "limit", + "options": { + "limitField": 10 + } + } + ], + "type": "table" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 32 + }, + "id": 20, + "panels": [ ], + "title": "Distribution & trends", + "type": "row" + }, + { + "datasource": { + "type": "datasource", + "uid": "-- Mixed --" + }, + "description": "Query latency distribution histogram per warehouse.", + "fieldConfig": { + "defaults": { + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 0, + "y": 33 + }, + "id": 21, + "pluginVersion": "v11.4.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max by (warehouse_id) (databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Warehouse - {{warehouse_id}}", + "refId": "Query duration (p95)" + } + ], + "title": "Query latency distribution per warehouse", + "type": "histogram" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Compares current median (p50) query latency to a 7-day rolling median baseline. X-axis shows the selected time range. For each point in time, the baseline is calculated from the previous 7 days. When the current line rises above the baseline, queries are slower than the recent 7-day average.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 8, + "y": 33 + }, + "id": 22, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n max(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.50\"})\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "Current p50", + "refId": "Query p50 latency (max)" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "max(quantile_over_time(0.5, databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.50\"}[7d]))", + "format": "time_series", + "instant": false, + "legendFormat": "7 days median", + "refId": "Query p50 latency (7d baseline)" + } + ], + "title": "Query latency: current median vs. 7 days median", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Multiple lines showing daily changes.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "percentunit" + } + }, + "gridPos": { + "h": 8, + "w": 8, + "x": 16, + "y": 33 + }, + "id": 23, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n (\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 1d)\n -\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 2d)\n )\n /\n sum by (job,workspace_id,instance) (databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"} offset 2d)\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "DoD", + "refId": "DoD queries delta" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time((\n sum(databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n /\n sum(databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"})\n)[30m:])\n", + "format": "time_series", + "instant": false, + "legendFormat": "Error rate %", + "refId": "Query error rate (aggregate)" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "max(\n (\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 1d)\n -\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 2d)\n )\n /\n avg_over_time(databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}[1d] offset 2d)\n)\n", + "format": "time_series", + "instant": false, + "legendFormat": "DoD p95 (max)", + "refId": "DoD p95 latency delta (max)" + } + ], + "title": "DoD changes (queries, error %, p95)", + "type": "timeseries" + }, + { + "collapsed": false, + "gridPos": { + "h": 1, + "w": 0, + "x": 0, + "y": 41 + }, + "id": 24, + "panels": [ ], + "title": "Performance by warehouse", + "type": "row" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query volume over time by warehouse (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 0, + "y": 42 + }, + "id": 25, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_queries_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{warehouse_id}}", + "refId": "Queries by warehouse (time series)" + } + ], + "title": "Queries by warehouse", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query errors over time by warehouse (adapts to dashboard time range).", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 6, + "y": 42 + }, + "id": 26, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_query_errors_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{warehouse_id}}", + "refId": "Query errors by warehouse (time series)" + } + ], + "title": "Errors by warehouse", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Query p95 latency over time by warehouse.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "s" + } + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 12, + "y": 42 + }, + "id": 27, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_query_duration_seconds_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\", quantile=\"0.95\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{warehouse_id}}", + "refId": "Query latency by warehouse (time series)" + } + ], + "title": "Query p95 latency by warehouse", + "type": "timeseries" + }, + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "description": "Concurrent queries by warehouse.", + "fieldConfig": { + "defaults": { + "custom": { + "fillOpacity": 30, + "gradientMode": "opacity", + "lineInterpolation": "smooth", + "lineWidth": 2, + "showPoints": "never" + }, + "unit": "short" + } + }, + "gridPos": { + "h": 8, + "w": 6, + "x": 18, + "y": 42 + }, + "id": 28, + "options": { + "legend": { + "calcs": [ ], + "displayMode": "list" + }, + "tooltip": { + "mode": "multi", + "sort": "desc" + } + }, + "pluginVersion": "v11.0.0", + "targets": [ + { + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "expr": "last_over_time(\n databricks_queries_running_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\",instance=~\"$instance\"}\n[30m:])", + "format": "time_series", + "instant": false, + "legendFormat": "{{warehouse_id}}", + "refId": "Concurrency by warehouse" + } + ], + "title": "Concurrency by warehouse", + "type": "timeseries" + } + ], + "refresh": "30s", + "schemaVersion": 39, + "tags": [ + "databricks-mixin" + ], + "templating": { + "list": [ + { + "label": "Data source", + "name": "datasource", + "query": "prometheus", + "regex": "", + "type": "datasource" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Job", + "multi": true, + "name": "job", + "query": "label_values(databricks_billing_dbus_sliding{}, job)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".*", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Workspace", + "multi": true, + "name": "workspace_id", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\"}, workspace_id)", + "refresh": 2, + "sort": 1, + "type": "query" + }, + { + "allValue": ".+", + "datasource": { + "type": "prometheus", + "uid": "${datasource}" + }, + "includeAll": true, + "label": "Instance", + "multi": true, + "name": "instance", + "query": "label_values(databricks_billing_dbus_sliding{job=~\"$job\",workspace_id=~\"$workspace_id\"}, instance)", + "refresh": 2, + "sort": 1, + "type": "query" + } + ] + }, + "time": { + "from": "now-1h", + "to": "now" + }, + "timezone": "default", + "title": "Databricks Warehouses & Queries", + "uid": "databricks_warehouses_queries" + } \ No newline at end of file diff --git a/mixin/g.libsonnet b/mixin/g.libsonnet new file mode 100644 index 0000000..59a7e52 --- /dev/null +++ b/mixin/g.libsonnet @@ -0,0 +1,2 @@ +// Auto-generated file, do not edit +import 'github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet' diff --git a/mixin/jsonnetfile.json b/mixin/jsonnetfile.json new file mode 100644 index 0000000..eb82ae8 --- /dev/null +++ b/mixin/jsonnetfile.json @@ -0,0 +1,33 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet-lib.git", + "subdir": "grafonnet" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "common-lib" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "grafana-cloud-integration-utils" + } + }, + "version": "master" + } + ], + "legacyImports": true +} diff --git a/mixin/jsonnetfile.lock.json b/mixin/jsonnetfile.lock.json new file mode 100644 index 0000000..730e8fe --- /dev/null +++ b/mixin/jsonnetfile.lock.json @@ -0,0 +1,96 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet-lib.git", + "subdir": "grafonnet" + } + }, + "version": "a1d61cce1da59c71409b99b5c7568511fec661ea", + "sum": "342u++/7rViR/zj2jeJOjshzglkZ1SY+hFNuyCBFMdc=" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-latest" + } + }, + "version": "8a27651b56fbdba45a389ccb11440200091c73a1", + "sum": "V9vAj21qJOc2DlMPDgB1eEjSQU4A+sAA4AXuJ6bd4xc=" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-v11.0.0" + } + }, + "version": "8a27651b56fbdba45a389ccb11440200091c73a1", + "sum": "0BvzR0i4bS4hc2O3xDv6i9m52z7mPrjvqxtcPrGhynA=" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-v11.4.0" + } + }, + "version": "8a27651b56fbdba45a389ccb11440200091c73a1", + "sum": "aVAX09paQYNOoCSKVpuk1exVIyBoMt/C50QJI+Q/3nA=" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "common-lib" + } + }, + "version": "816f0836175fb282a470379249d325e05236576c", + "sum": "XnpzeZC2Pa1aEtDOqy+KTndcUTnwFMlj6XlZmv3XBj0=" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/jsonnet-libs.git", + "subdir": "grafana-cloud-integration-utils" + } + }, + "version": "816f0836175fb282a470379249d325e05236576c", + "sum": "f4RYXgxayzDyeBjedbcUWaxIk3WN+y+wsEwcn+cWnJw=" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/docsonnet.git", + "subdir": "doc-util" + } + }, + "version": "6ac6c69685b8c29c54515448eaca583da2d88150", + "sum": "BrAL/k23jq+xy9oA7TWIhUx07dsA/QLm3g7ktCwe//U=" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "4d7f8cb24d613430799f9d56809cc6964f35cea9", + "sum": "hOrwkOx34tOXqoDVnwuI/Uf/dr9HFFSPWpDPOvnEGrk=" + }, + { + "source": { + "git": { + "remote": "https://github.com/yugui/jsonnetunit.git", + "subdir": "jsonnetunit" + } + }, + "version": "6927c58cae7624a00f368b977ccc477d4f74071f", + "sum": "9FFqqln65hooRF0l6rjICDtnTxUlmDj34+sKMh4sjPI=" + } + ], + "legacyImports": false +} diff --git a/mixin/links.libsonnet b/mixin/links.libsonnet new file mode 100644 index 0000000..f628be6 --- /dev/null +++ b/mixin/links.libsonnet @@ -0,0 +1,26 @@ +local g = import './g.libsonnet'; + +{ + new(this): { + local link = g.dashboard.link, + local dashboards = this.grafana.dashboards, + local prefix = this.config.dashboardNamePrefix, + local uid = this.config.uid, + local vars = this.grafana.variables, + + databricksOverview: + link.link.new('Overview', '/d/' + uid + '_overview/databricks-overview') + + link.link.options.withKeepTime(true) + + link.link.options.withIncludeVars(true), + + databricksJobsPipelines: + link.link.new('Jobs & Pipelines', '/d/' + uid + '_jobs_pipelines/databricks-jobs-and-pipelines') + + link.link.options.withKeepTime(true) + + link.link.options.withIncludeVars(true), + + databricksWarehousesQueries: + link.link.new('Warehouses & Queries', '/d/' + uid + '_warehouses_queries/databricks-warehouses-and-queries') + + link.link.options.withKeepTime(true) + + link.link.options.withIncludeVars(true), + }, +} diff --git a/mixin/main.libsonnet b/mixin/main.libsonnet new file mode 100644 index 0000000..88195b7 --- /dev/null +++ b/mixin/main.libsonnet @@ -0,0 +1,49 @@ +local alerts = import './alerts.libsonnet'; +local config = import './config.libsonnet'; +local dashboards = import './dashboards.libsonnet'; +local links = import './links.libsonnet'; +local panels = import './panels.libsonnet'; +local rows = import './rows.libsonnet'; +local commonlib = import 'common-lib/common/main.libsonnet'; + +{ + withConfigMixin(config): { + config+: config, + }, + + new(): { + + local this = self, + config: config, + + signals: + { + [sig]: commonlib.signals.unmarshallJsonMulti( + this.config.signals[sig], + type=this.config.metricsSource + ) + for sig in std.objectFields(this.config.signals) + }, + + grafana: { + variables: commonlib.variables.new( + filteringSelector=this.config.filteringSelector, + groupLabels=this.config.groupLabels, + instanceLabels=this.config.instanceLabels, + varMetric='databricks_billing_dbus_sliding', + customAllValue='.+', + enableLokiLogs=this.config.enableLokiLogs, + ), + annotations: {}, + links: links.new(this), + panels: panels.new(this), + dashboards: dashboards.new(this), + rows: rows.new(this), + }, + + prometheus: { + alerts: alerts.new(this), + recordingRules: {}, + }, + }, +} diff --git a/mixin/mixin.libsonnet b/mixin/mixin.libsonnet new file mode 100644 index 0000000..277d1fc --- /dev/null +++ b/mixin/mixin.libsonnet @@ -0,0 +1,56 @@ +local databrickslib = import './main.libsonnet'; +local config = (import './config.libsonnet'); +local util = import 'grafana-cloud-integration-utils/util.libsonnet'; + +local databricks = + databrickslib.new() + + databrickslib.withConfigMixin( + { + filteringSelector: config.filteringSelector, + uid: config.uid, + enableLokiLogs: false, + } + ); + +local optional_labels = { + job+: { + label: 'Job', + allValue: '.+', + }, + workspace_id+: { + label: 'Workspace', + allValue: '.*', + }, + sku_name+: { + label: 'SKU', + allValue: '.*', + }, + job_name+: { + label: 'Job Name', + allValue: '.*', + multi: true, + }, + pipeline_name+: { + label: 'Pipeline Name', + allValue: '.*', + multi: true, + }, + warehouse_id+: { + label: 'Warehouse ID', + allValue: '.*', + multi: true, + }, +}; + +{ + grafanaDashboards+:: { + [fname]: + local dashboard = databricks.grafana.dashboards[fname]; + dashboard + util.patch_variables(dashboard, optional_labels) + + for fname in std.objectFields(databricks.grafana.dashboards) + }, + + prometheusAlerts+:: databricks.prometheus.alerts, + prometheusRules+:: databricks.prometheus.recordingRules, +} diff --git a/mixin/panels.libsonnet b/mixin/panels.libsonnet new file mode 100644 index 0000000..e1dd899 --- /dev/null +++ b/mixin/panels.libsonnet @@ -0,0 +1,1026 @@ +local g = import './g.libsonnet'; +local commonlib = import 'common-lib/common/main.libsonnet'; + +{ + new(this):: + { + local signals = this.signals, + + // Overview Dashboard Panels - Row 1 Statistics + yesterdayCostStat: + commonlib.panels.generic.stat.base.new( + 'Total cost (24h window)', + targets=[signals.overview.yesterdayCost.asTarget()], + description='Total cost estimate for the past 24 hours. This is a rolling 1-day window from exporter.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.options.withTextMode('value') + + g.panel.stat.standardOptions.withUnit('currencyUSD') + + g.panel.stat.standardOptions.withDecimals(2), + + dodCostDeltaStat: + commonlib.panels.generic.stat.base.new( + 'Cost change % (previous 24h)', + targets=[signals.overview.dodCostDelta.asTarget()], + description='Percentage change comparing current 24h window to the 24h window from yesterday. Green = low growth, Yellow = moderate growth (>15%), Red = high growth (>25%).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.options.withTextMode('value') + + g.panel.stat.standardOptions.withUnit('percentunit') + + g.panel.stat.standardOptions.withDecimals(1) + + g.panel.stat.standardOptions.thresholds.withSteps([ + g.panel.stat.thresholdStep.withColor('green'), + g.panel.stat.thresholdStep.withColor('yellow') + g.panel.stat.thresholdStep.withValue(0.15), + g.panel.stat.thresholdStep.withColor('red') + g.panel.stat.thresholdStep.withValue(0.25), + ]), + + totalDbusConsumedStat: + commonlib.panels.generic.stat.base.new( + 'Total DBUs (24h window)', + targets=[signals.overview.totalDbusConsumed.asTarget()], + description='Total DBUs consumed over the past 24 hours. This is a rolling 1-day window from the exporter.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.options.withTextMode('value') + + g.panel.stat.standardOptions.withUnit('short'), + + jobsSuccessRateStat: + g.panel.gauge.new('Jobs success %') + + g.panel.gauge.queryOptions.withTargets([signals.jobsAndPipelines.jobSuccessRate.asTarget()]) + + g.panel.gauge.panelOptions.withDescription('Percentage of successful jobs (adapts to dashboard time range).') + + g.panel.gauge.standardOptions.withUnit('percentunit') + + g.panel.gauge.standardOptions.withMin(0) + + g.panel.gauge.standardOptions.withMax(1) + + g.panel.gauge.standardOptions.thresholds.withSteps([ + g.panel.gauge.thresholdStep.withColor('red'), + g.panel.gauge.thresholdStep.withColor('yellow') + g.panel.gauge.thresholdStep.withValue(0.8), + g.panel.gauge.thresholdStep.withColor('green') + g.panel.gauge.thresholdStep.withValue(0.9), + ]) + + g.panel.gauge.options.withShowThresholdLabels(false) + + g.panel.gauge.options.withShowThresholdMarkers(true), + + pipelinesSuccessRateStat: + g.panel.gauge.new('Pipelines success %') + + g.panel.gauge.queryOptions.withTargets([signals.jobsAndPipelines.pipelineSuccessRate.asTarget()]) + + g.panel.gauge.panelOptions.withDescription('Percentage of successful pipelines (adapts to dashboard time range).') + + g.panel.gauge.standardOptions.withUnit('percentunit') + + g.panel.gauge.standardOptions.withMin(0) + + g.panel.gauge.standardOptions.withMax(1) + + g.panel.gauge.standardOptions.thresholds.withSteps([ + g.panel.gauge.thresholdStep.withColor('red'), + g.panel.gauge.thresholdStep.withColor('yellow') + g.panel.gauge.thresholdStep.withValue(0.8), + g.panel.gauge.thresholdStep.withColor('green') + g.panel.gauge.thresholdStep.withValue(0.9), + ]) + + g.panel.gauge.options.withShowThresholdLabels(false) + + g.panel.gauge.options.withShowThresholdMarkers(true), + + sqlErrorRateStat: + g.panel.gauge.new('SQL error %') + + g.panel.gauge.queryOptions.withTargets([signals.warehousesAndQueries.queryErrorRateAggregate.asTarget()]) + + g.panel.gauge.panelOptions.withDescription('SQL query error percentage (adapts to dashboard time range).') + + g.panel.gauge.standardOptions.withUnit('percentunit') + + g.panel.gauge.standardOptions.withMin(0) + + g.panel.gauge.standardOptions.withMax(0.2) + + g.panel.gauge.standardOptions.thresholds.withSteps([ + g.panel.gauge.thresholdStep.withColor('green'), + g.panel.gauge.thresholdStep.withColor('yellow') + g.panel.gauge.thresholdStep.withValue(0.05), + g.panel.gauge.thresholdStep.withColor('red') + g.panel.gauge.thresholdStep.withValue(0.1), + ]) + + g.panel.gauge.options.withShowThresholdLabels(false) + + g.panel.gauge.options.withShowThresholdMarkers(true), + + // Overview Dashboard Panels - Row 2 + costBySkuChart: + commonlib.panels.generic.timeSeries.base.new( + 'Cost by SKU', + targets=[ + signals.overview.costBySku.asTarget(), + ], + description='Cost breakdown by SKU over time (24h rolling window from exporter).' + ) + + g.panel.timeSeries.standardOptions.withUnit('currencyUSD') + + g.panel.timeSeries.options.legend.withShowLegend(true) + + g.panel.timeSeries.options.legend.withPlacement('bottom'), + + costPerDbuBySkuChart: + commonlib.panels.generic.timeSeries.base.new( + 'Cost per DBU by SKU', + targets=[ + signals.overview.costPerDbuBySku.asTarget(), + ], + description='Cost efficiency metric - shows how much each DBU costs for each SKU. Lower is more cost-efficient (24h rolling window).' + ) + + g.panel.timeSeries.standardOptions.withUnit('currencyUSD') + + g.panel.timeSeries.options.legend.withShowLegend(true) + + g.panel.timeSeries.options.legend.withPlacement('bottom'), + + globalReliabilityChart: + commonlib.panels.generic.timeSeries.base.new( + 'Global reliability', + targets=[ + signals.jobsAndPipelines.jobSuccessRate.asTarget() + + g.query.prometheus.withLegendFormat('Jobs success rate'), + signals.jobsAndPipelines.pipelineSuccessRate.asTarget() + + g.query.prometheus.withLegendFormat('Pipelines success rate'), + signals.warehousesAndQueries.queryErrorRate.asTarget() + + g.query.prometheus.withLegendFormat('Query errors rate'), + ], + description='Jobs and pipelines success rate (%) and SQL error rate (%) overlay.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit'), + + // Overview Dashboard Panels - Row 3 + topWorkspacesByCostTable: + commonlib.panels.generic.table.base.new( + 'Top workspaces by cost', + targets=[ + signals.overview.topWorkspacesByCost.asTableTarget(), + ], + description='Workspaces with highest costs (24h rolling window from exporter).' + ) + + g.panel.table.standardOptions.withOverridesMixin([ + g.panel.table.fieldOverride.byName.new('Cost') + + g.panel.table.fieldOverride.byName.withProperty('unit', 'currencyUSD') + + g.panel.table.fieldOverride.byName.withProperty('decimals', 2), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + job: true, + instance: true, + }, + indexByName: { + workspace_id: 0, + Value: 1, + }, + renameByName: { + workspace_id: 'Workspace ID', + Value: 'Cost', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Cost', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topSkusByCostTable: + commonlib.panels.generic.table.base.new( + 'Top SKUs by cost', + targets=[ + signals.overview.topSkusByCost.asTableTarget(), + ], + description='SKUs with highest costs (24h rolling window from exporter).' + ) + + g.panel.table.standardOptions.withOverridesMixin([ + g.panel.table.fieldOverride.byName.new('Total Cost') + + g.panel.table.fieldOverride.byName.withProperty('unit', 'currencyUSD') + + g.panel.table.fieldOverride.byName.withProperty('decimals', 2), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + job: true, + instance: true, + }, + indexByName: { + workspace_id: 0, + sku_name: 1, + Value: 2, + }, + renameByName: { + workspace_id: 'Workspace ID', + sku_name: 'SKU Name', + Value: 'Total Cost', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Cost', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + // Overview Dashboard Panels - Row 4 + topDbusByWorkspaceTable: + commonlib.panels.generic.table.base.new( + 'DBUs by workspace and SKU', + targets=[signals.overview.billingDbusTotal.asTableTarget()], + description='DBUs consumed broken down by workspace and SKU (24h rolling window from exporter).' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('DBUs') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + job: true, + instance: true, + __name__: true, + }, + indexByName: { + workspace_id: 0, + sku_name: 1, + Value: 2, + }, + renameByName: { + workspace_id: 'Workspace ID', + sku_name: 'SKU Name', + Value: 'DBUs', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'DBUs', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + // Overview Dashboard Panels - Row 5 + jobsFailureTrend: + commonlib.panels.generic.timeSeries.base.new( + 'Jobs failure trend', + targets=[signals.jobsAndPipelines.jobFailureRate.asTarget()], + description='Job failure rate over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit') + + g.panel.timeSeries.standardOptions.withNoValue('0'), + + pipelinesFailureTrend: + commonlib.panels.generic.timeSeries.base.new( + 'Pipelines failure trend', + targets=[signals.jobsAndPipelines.pipelineFailureRate.asTarget()], + description='Pipeline failure rate over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit') + + g.panel.timeSeries.standardOptions.withNoValue('0'), + + sqlErrorTrend: + commonlib.panels.generic.timeSeries.base.new( + 'SQL error trend', + targets=[signals.warehousesAndQueries.queryErrorRate.asTarget()], + description='SQL query error rate over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit') + + g.panel.timeSeries.standardOptions.withNoValue('0'), + + // Jobs & Pipelines Dashboard Panels - Row 1 Statistics + jobRunsStat: + commonlib.panels.generic.stat.base.new( + 'Job runs', + targets=[signals.jobsAndPipelines.jobsThroughput.asTarget()], + description='Job runs (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('short'), + + pipelineRunsStat: + commonlib.panels.generic.stat.base.new( + 'Pipeline runs', + targets=[signals.jobsAndPipelines.pipelinesThroughput.asTarget()], + description='Pipeline runs (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('short'), + + jobSuccessRateStat: + commonlib.panels.generic.stat.base.new( + 'Job success %', + targets=[signals.jobsAndPipelines.jobSuccessRate.asTarget()], + description='Percentage of successful jobs (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('percentunit'), + + pipelineSuccessRateStat: + commonlib.panels.generic.stat.base.new( + 'Pipeline success %', + targets=[signals.jobsAndPipelines.pipelineSuccessRate.asTarget()], + description='Percentage of successful pipelines (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('percentunit'), + + jobP95DurationStat: + commonlib.panels.generic.stat.base.new( + 'Job p95 duration (max)', + targets=[signals.jobsAndPipelines.jobRunP95Aggregate.asTarget()], + description='Maximum p95 job duration across all jobs.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('s'), + + pipelineP95DurationStat: + commonlib.panels.generic.stat.base.new( + 'Pipeline p95 duration (max)', + targets=[signals.jobsAndPipelines.pipelineRunP95Aggregate.asTarget()], + description='Maximum p95 pipeline duration across all pipelines.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('s'), + + // Jobs & Pipelines Dashboard Panels - Row 2 + runsThroughputChart: + commonlib.panels.generic.timeSeries.base.new( + 'Total runs', + targets=[ + signals.jobsAndPipelines.jobsThroughput.asTarget(), + signals.jobsAndPipelines.pipelinesThroughput.asTarget(), + ], + description='Number of job and pipeline runs (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + // Jobs & Pipelines Dashboard Panels - Row 3 + failureRateByWorkspaceChart: + commonlib.panels.generic.timeSeries.base.new( + 'Failure rate by workspace', + targets=[ + signals.jobsAndPipelines.jobFailureRate.asTarget(), + signals.jobsAndPipelines.pipelineFailureRate.asTarget(), + ], + description='Job and pipeline failure rates by workspace (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit'), + + retriesVsFailuresChart: + commonlib.panels.generic.timeSeries.base.new( + 'Retries', + targets=[ + signals.jobsAndPipelines.taskRetries.asTarget(), + signals.jobsAndPipelines.pipelineRetries.asTarget(), + ], + description='Number of task and pipeline retries (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short') + + g.panel.timeSeries.options.legend.withAsTable(true) + + g.panel.timeSeries.options.legend.withPlacement('right'), + + jobP95DurationChart: + commonlib.panels.generic.timeSeries.base.new( + 'Job p95 duration', + targets=[ + signals.jobsAndPipelines.jobRunP95Aggregate.asTarget(), + ], + description='Maximum p95 duration across all jobs over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s') + + g.panel.timeSeries.fieldConfig.defaults.custom.withShowPoints('never') + + g.panel.timeSeries.options.legend.withDisplayMode('list') + + g.panel.timeSeries.options.legend.withPlacement('bottom'), + + pipelineP95DurationChart: + commonlib.panels.generic.timeSeries.base.new( + 'Pipeline p95 duration', + targets=[ + signals.jobsAndPipelines.pipelineRunP95Aggregate.asTarget(), + ], + description='Maximum p95 duration across all pipelines over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s') + + g.panel.timeSeries.fieldConfig.defaults.custom.withShowPoints('never') + + g.panel.timeSeries.options.legend.withDisplayMode('list') + + g.panel.timeSeries.options.legend.withPlacement('bottom'), + + // Jobs & Pipelines Dashboard Panels - Row 4 + jobsStatusBreakdownChart: + commonlib.panels.generic.timeSeries.base.new( + 'Jobs status breakdown', + targets=[signals.jobsAndPipelines.jobStatusBreakdown.asTarget()], + description='Job status breakdown showing counts (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short') + + g.panel.timeSeries.options.legend.withAsTable(true) + + g.panel.timeSeries.options.legend.withPlacement('right') + + g.panel.timeSeries.fieldConfig.defaults.custom.stacking.withMode('normal'), + + pipelinesStatusBreakdownChart: + commonlib.panels.generic.timeSeries.base.new( + 'Pipelines status breakdown', + targets=[signals.jobsAndPipelines.pipelineStatusBreakdown.asTarget()], + description='Pipeline status breakdown showing counts (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short') + + g.panel.timeSeries.options.legend.withAsTable(true) + + g.panel.timeSeries.options.legend.withPlacement('right') + + g.panel.timeSeries.fieldConfig.defaults.custom.stacking.withMode('normal'), + + // Warehouses & Queries Dashboard Panels - Row 1 Statistics + queriesTotalStat: + commonlib.panels.generic.stat.base.new( + 'Total queries', + targets=[signals.warehousesAndQueries.queryLoad.asTarget()], + description='Total queries executed (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('short'), + + queryErrorRateStat: + commonlib.panels.generic.stat.base.new( + 'Query error %', + targets=[signals.warehousesAndQueries.queryErrorRateAggregate.asTarget()], + description='Error percentage (adapts to dashboard time range).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('percentunit'), + + queryP95LatencyStat: + commonlib.panels.generic.stat.base.new( + 'p95 latency (max)', + targets=[signals.warehousesAndQueries.queryP95Latency.asTarget()], + description='Maximum p95 query latency across all warehouses.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('s'), + + concurrencyCurrentStat: + commonlib.panels.generic.stat.base.new( + 'Max concurrent queries (now)', + targets=[signals.warehousesAndQueries.concurrencyCurrent.asTarget()], + description='Maximum concurrent queries across all warehouses.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('short'), + + concurrencyBaseline7dStat: + commonlib.panels.generic.stat.base.new( + 'Max concurrent queries (7d p95)', + targets=[signals.warehousesAndQueries.concurrencyBaseline.asTarget()], + description='Maximum baseline concurrency over 7 days (p95).' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('short'), + + dodQueriesDiffStat: + commonlib.panels.generic.stat.base.new( + 'DoD queries diff %', + targets=[signals.warehousesAndQueries.dodQueriesDelta.asTarget()], + description='Day-over-day query count change.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('percentunit'), + + dodP95LatencyDiffStat: + commonlib.panels.generic.stat.base.new( + 'DoD p95 latency diff %', + targets=[signals.warehousesAndQueries.dodP95LatencyDelta.asTarget()], + description='Day-over-day p95 latency change.' + ) + + g.panel.stat.options.withGraphMode('none') + + g.panel.stat.standardOptions.withUnit('percentunit'), + + // SQL/BI Dashboard Panels - Row 2 + queryLoadChart: + commonlib.panels.generic.timeSeries.base.new( + 'Query load (rate)', + targets=[signals.warehousesAndQueries.queryLoad.asTarget()], + description='Query execution rate over time.' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + latencyP50P95Chart: + commonlib.panels.generic.timeSeries.base.new( + 'Query latency: p50 vs. p95', + targets=[ + signals.warehousesAndQueries.queryP50Latency.asTarget(), + signals.warehousesAndQueries.queryP95Latency.asTarget(), + ], + description='Query latency: p50 vs. p95.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s'), + + // SQL/BI Dashboard Panels - Row 3 + sqlErrorRateChart: + commonlib.panels.generic.timeSeries.base.new( + 'SQL error rate', + targets=[signals.warehousesAndQueries.queryErrorRate.asTarget()], + description='SQL error rate with warn/crit bands.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit'), + + concurrencyVsLatencyChart: + commonlib.panels.generic.timeSeries.base.new( + 'Concurrency vs latency', + targets=[ + signals.warehousesAndQueries.concurrencyCurrent.asTarget(), + signals.warehousesAndQueries.queryP95Latency.asTarget(), + ], + description='Overlay showing saturation effect.' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + queriesByWorkspaceChart: + commonlib.panels.generic.timeSeries.base.new( + 'Queries by workspace', + targets=[signals.warehousesAndQueries.queriesByWorkspace.asTarget()], + description='Query volume by workspace.' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + // SQL/BI Dashboard Panels - Row 4 + queryLatencyDistribution: + g.panel.histogram.new('Query latency distribution per warehouse') + + g.panel.histogram.queryOptions.withTargets([signals.warehousesAndQueries.queryDuration.asTarget()]) + + g.panel.histogram.panelOptions.withDescription('Query latency distribution histogram per warehouse.') + + g.panel.histogram.standardOptions.withUnit('s'), + + medianLatencyVs7dChart: + commonlib.panels.generic.timeSeries.base.new( + 'Query latency: current median vs. 7 days median', + targets=[ + signals.warehousesAndQueries.queryP50Latency.asTarget(), + signals.warehousesAndQueries.queryP50Latency7dBaseline.asTarget(), + ], + description='Compares current median (p50) query latency to a 7-day rolling median baseline. X-axis shows the selected time range. For each point in time, the baseline is calculated from the previous 7 days. When the current line rises above the baseline, queries are slower than the recent 7-day average.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s'), + + dodChangesChart: + commonlib.panels.generic.timeSeries.base.new( + 'DoD changes (queries, error %, p95)', + targets=[ + signals.warehousesAndQueries.dodQueriesDelta.asTarget(), + signals.warehousesAndQueries.queryErrorRateAggregate.asTarget(), + signals.warehousesAndQueries.dodP95LatencyDelta.asTarget(), + ], + description='Multiple lines showing daily changes.' + ) + + g.panel.timeSeries.standardOptions.withUnit('percentunit'), + + // Detailed drill-down panels - Jobs + topJobsByRunsTable: + commonlib.panels.generic.table.base.new( + 'Top jobs by runs', + targets=[signals.jobsAndPipelines.topJobsByRunsTableSignal.asTableTarget()], + description='Jobs with most runs (all time).' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Runs') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + __name__: true, + instance: true, + job: true, + Time: true, + }, + indexByName: { + workspace_id: 0, + job_id: 1, + job_name: 2, + Value: 3, + }, + renameByName: { + workspace_id: 'Workspace ID', + job_id: 'Job ID', + job_name: 'Job Name', + Value: 'Total Runs', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Runs', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topJobsByDurationTable: + commonlib.panels.generic.table.base.new( + 'Top jobs by p95 duration', + targets=[signals.jobsAndPipelines.jobDurationByName.asTableTarget()], + description='Jobs with longest p95 duration.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('p95 Duration (seconds)') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('s') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + quantile: true, + }, + indexByName: { + workspace_id: 0, + job_id: 1, + job_name: 2, + Value: 3, + }, + renameByName: { + workspace_id: 'Workspace ID', + job_id: 'Job ID', + job_name: 'Job Name', + Value: 'p95 Duration (seconds)', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'p95 Duration (seconds)', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topJobsByFailuresTable: + commonlib.panels.generic.table.base.new( + 'Top jobs by failures', + targets=[signals.jobsAndPipelines.jobFailuresByName.asTableTarget()], + description='Jobs with most failures (adapts to dashboard time range).' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Failures') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + }, + indexByName: { + workspace_id: 0, + job_id: 1, + job_name: 2, + status: 3, + Value: 4, + }, + renameByName: { + workspace_id: 'Workspace ID', + job_id: 'Job ID', + job_name: 'Job Name', + status: 'Status', + Value: 'Total Failures', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Failures', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + jobRunsByNameChart: + commonlib.panels.generic.timeSeries.base.new( + 'Job runs by name', + targets=[signals.jobsAndPipelines.jobRunsByNameChartSignal.asTarget()], + description='Job run counts over time by job name (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short') + + g.panel.timeSeries.options.legend.withDisplayMode('table') + + g.panel.timeSeries.options.legend.withPlacement('right'), + + jobDurationByNameChart: + commonlib.panels.generic.timeSeries.base.new( + 'Job p95 duration by name', + targets=[signals.jobsAndPipelines.jobDurationByName.asTarget()], + description='Job p95 duration over time by job name.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s') + + g.panel.timeSeries.options.legend.withDisplayMode('table') + + g.panel.timeSeries.options.legend.withPlacement('right'), + + // Detailed drill-down panels - Pipelines + topPipelinesByRunsTable: + commonlib.panels.generic.table.base.new( + 'Top pipelines by runs', + targets=[signals.jobsAndPipelines.topPipelinesByRunsTableSignal.asTableTarget()], + description='Pipelines with most runs (all time).' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Runs') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + }, + indexByName: { + workspace_id: 0, + pipeline_id: 1, + pipeline_name: 2, + Value: 3, + }, + renameByName: { + workspace_id: 'Workspace ID', + pipeline_id: 'Pipeline ID', + pipeline_name: 'Pipeline Name', + Value: 'Total Runs', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Runs', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topPipelinesByDurationTable: + commonlib.panels.generic.table.base.new( + 'Top pipelines by p95 duration', + targets=[signals.jobsAndPipelines.pipelineDurationByName.asTableTarget()], + description='Pipelines with longest p95 duration.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('p95 Duration (seconds)') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('s') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + quantile: true, + }, + indexByName: { + workspace_id: 0, + pipeline_id: 1, + pipeline_name: 2, + Value: 3, + }, + renameByName: { + workspace_id: 'Workspace ID', + pipeline_id: 'Pipeline ID', + pipeline_name: 'Pipeline Name', + Value: 'p95 Duration (seconds)', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'p95 Duration (seconds)', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topPipelinesByFailuresTable: + commonlib.panels.generic.table.base.new( + 'Top pipelines by failures', + targets=[signals.jobsAndPipelines.pipelineFailuresByName.asTableTarget()], + description='Pipelines with most failures (adapts to dashboard time range).' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Failures') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + }, + indexByName: { + workspace_id: 0, + pipeline_id: 1, + pipeline_name: 2, + status: 3, + Value: 4, + }, + renameByName: { + workspace_id: 'Workspace ID', + pipeline_id: 'Pipeline ID', + pipeline_name: 'Pipeline Name', + status: 'Status', + Value: 'Total Failures', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Failures', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + pipelineFreshnessByNameTable: + commonlib.panels.generic.table.base.new( + 'Pipeline freshness lag', + targets=[signals.jobsAndPipelines.pipelineFreshnessByName.asTableTarget()], + description='Data freshness lag by pipeline.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Freshness Lag (seconds)') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('s') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + Time: true, + __name__: true, + instance: true, + job: true, + }, + indexByName: { + workspace_id: 0, + pipeline_id: 1, + pipeline_name: 2, + Value: 3, + }, + renameByName: { + workspace_id: 'Workspace ID', + pipeline_id: 'Pipeline ID', + pipeline_name: 'Pipeline Name', + Value: 'Freshness Lag (seconds)', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Freshness Lag (seconds)', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + pipelineRunsByNameChart: + commonlib.panels.generic.timeSeries.base.new( + 'Pipeline runs by name', + targets=[signals.jobsAndPipelines.pipelineRunsByNameChartSignal.asTarget()], + description='Pipeline run counts over time by pipeline name (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short') + + g.panel.timeSeries.options.legend.withDisplayMode('table') + + g.panel.timeSeries.options.legend.withPlacement('right'), + + pipelineDurationByNameChart: + commonlib.panels.generic.timeSeries.base.new( + 'Pipeline p95 duration by name', + targets=[signals.jobsAndPipelines.pipelineDurationByName.asTarget()], + description='Pipeline p95 duration over time by pipeline name.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s') + + g.panel.timeSeries.options.legend.withDisplayMode('table') + + g.panel.timeSeries.options.legend.withPlacement('right'), + + // Detailed drill-down panels - SQL Warehouses + topWarehousesByQueriesTable: + commonlib.panels.generic.table.base.new( + 'Top warehouses by queries', + targets=[signals.warehousesAndQueries.topWarehousesByQueries.asTableTarget()], + description='Warehouses ranked by total query volume.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Queries') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + __name__: true, + Time: true, + instance: true, + job: true, + }, + indexByName: { + warehouse_id: 0, + Value: 1, + }, + renameByName: { + warehouse_id: 'Warehouse ID', + Value: 'Total Queries', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Queries', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topWarehousesByErrorsTable: + commonlib.panels.generic.table.base.new( + 'Top warehouses by errors', + targets=[signals.warehousesAndQueries.topWarehousesByErrors.asTableTarget()], + description='Warehouses ranked by total error count.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('Total Errors') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('short') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + __name__: true, + Time: true, + instance: true, + job: true, + }, + indexByName: { + warehouse_id: 0, + Value: 1, + }, + renameByName: { + warehouse_id: 'Warehouse ID', + Value: 'Total Errors', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'Total Errors', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + topWarehousesByLatencyTable: + commonlib.panels.generic.table.base.new( + 'Top warehouses by p95 latency', + targets=[signals.warehousesAndQueries.topWarehousesByLatency.asTableTarget()], + description='Warehouses ranked by highest p95 latency.' + ) + + g.panel.table.standardOptions.withOverrides([ + g.panel.table.fieldOverride.byName.new('p95 Latency (seconds)') + + g.panel.table.fieldOverride.byName.withPropertiesFromOptions( + g.panel.table.standardOptions.withUnit('s') + ), + ]) + + g.panel.table.queryOptions.withTransformations([ + { + id: 'organize', + options: { + excludeByName: { + __name__: true, + Time: true, + instance: true, + job: true, + }, + indexByName: { + warehouse_id: 0, + Value: 1, + }, + renameByName: { + warehouse_id: 'Warehouse ID', + Value: 'p95 Latency (seconds)', + }, + }, + }, + { id: 'sortBy', options: { sort: [{ field: 'p95 Latency (seconds)', desc: true }] } }, + { id: 'limit', options: { limitField: 10 } }, + ]), + + queriesByWarehouseChart: + commonlib.panels.generic.timeSeries.base.new( + 'Queries by warehouse', + targets=[signals.warehousesAndQueries.queriesByWarehouse.asTarget()], + description='Query volume over time by warehouse (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + queryErrorsByWarehouseChart: + commonlib.panels.generic.timeSeries.base.new( + 'Errors by warehouse', + targets=[signals.warehousesAndQueries.queryErrorsByWarehouse.asTarget()], + description='Query errors over time by warehouse (adapts to dashboard time range).' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + + queryLatencyByWarehouseChart: + commonlib.panels.generic.timeSeries.base.new( + 'Query p95 latency by warehouse', + targets=[signals.warehousesAndQueries.queryLatencyByWarehouse.asTarget()], + description='Query p95 latency over time by warehouse.' + ) + + g.panel.timeSeries.standardOptions.withUnit('s'), + + concurrencyByWarehouseChart: + commonlib.panels.generic.timeSeries.base.new( + 'Concurrency by warehouse', + targets=[signals.warehousesAndQueries.concurrencyByWarehouse.asTarget()], + description='Concurrent queries by warehouse.' + ) + + g.panel.timeSeries.standardOptions.withUnit('short'), + }, +} diff --git a/mixin/rows.libsonnet b/mixin/rows.libsonnet new file mode 100644 index 0000000..2a94af0 --- /dev/null +++ b/mixin/rows.libsonnet @@ -0,0 +1,200 @@ +local g = import './g.libsonnet'; + +{ + new(this): + { + local panels = this.grafana.panels, + + // Overview Dashboard Rows + overviewStatistics: + g.panel.row.new('Overview') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.yesterdayCostStat { gridPos: { w: 4, h: 4 } }, + panels.dodCostDeltaStat { gridPos: { w: 4, h: 4 } }, + panels.totalDbusConsumedStat { gridPos: { w: 4, h: 4 } }, + panels.jobsSuccessRateStat { gridPos: { w: 4, h: 4 } }, + panels.pipelinesSuccessRateStat { gridPos: { w: 4, h: 4 } }, + panels.sqlErrorRateStat { gridPos: { w: 4, h: 4 } }, + ] + ), + + overviewCharts: + g.panel.row.new('Cost & reliability trends') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.costBySkuChart { gridPos: { w: 8, h: 8 } }, + panels.costPerDbuBySkuChart { gridPos: { w: 8, h: 8 } }, + panels.globalReliabilityChart { gridPos: { w: 8, h: 8 } }, + ] + ), + + overviewDecomposition: + g.panel.row.new('Cost decomposition') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.topWorkspacesByCostTable { gridPos: { w: 8, h: 6 } }, + panels.topSkusByCostTable { gridPos: { w: 8, h: 6 } }, + panels.topDbusByWorkspaceTable { gridPos: { w: 8, h: 6 } }, + ] + ), + + overviewTrends: + g.panel.row.new('Reliability trends') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.jobsFailureTrend { gridPos: { w: 8, h: 6 } }, + panels.pipelinesFailureTrend { gridPos: { w: 8, h: 6 } }, + panels.sqlErrorTrend { gridPos: { w: 8, h: 6 } }, + ] + ), + + // Workloads (Jobs & Pipelines) Dashboard Rows + workloadsStatistics: + g.panel.row.new('Workloads overview') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.jobRunsStat { gridPos: { w: 4, h: 4 } }, + panels.pipelineRunsStat { gridPos: { w: 4, h: 4 } }, + panels.jobSuccessRateStat { gridPos: { w: 4, h: 4 } }, + panels.pipelineSuccessRateStat { gridPos: { w: 4, h: 4 } }, + panels.jobP95DurationStat { gridPos: { w: 4, h: 4 } }, + panels.pipelineP95DurationStat { gridPos: { w: 4, h: 4 } }, + ] + ), + + workloadsThroughput: + g.panel.row.new('Throughput & duration') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.runsThroughputChart { gridPos: { w: 8, h: 8 } }, + panels.jobP95DurationChart { gridPos: { w: 8, h: 8 } }, + panels.pipelineP95DurationChart { gridPos: { w: 8, h: 8 } }, + ] + ), + + workloadsReliability: + g.panel.row.new('Reliability & stability') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.failureRateByWorkspaceChart { gridPos: { w: 12, h: 8 } }, + panels.retriesVsFailuresChart { gridPos: { w: 12, h: 8 } }, + ] + ), + + workloadsStatusBreakdown: + g.panel.row.new('Status breakdown') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.jobsStatusBreakdownChart { gridPos: { w: 12, h: 10 } }, + panels.pipelinesStatusBreakdownChart { gridPos: { w: 12, h: 10 } }, + ] + ), + + workloadsJobDrilldown: + g.panel.row.new('Jobs drill-down (by job name)') + + g.panel.row.withCollapsed(true) + + g.panel.row.withPanels( + [ + panels.topJobsByRunsTable { gridPos: { w: 8, h: 8 } }, + panels.topJobsByDurationTable { gridPos: { w: 8, h: 8 } }, + panels.topJobsByFailuresTable { gridPos: { w: 8, h: 8 } }, + panels.jobRunsByNameChart { gridPos: { w: 12, h: 10 } }, + panels.jobDurationByNameChart { gridPos: { w: 12, h: 10 } }, + ] + ), + + workloadsPipelineDrilldown: + g.panel.row.new('Pipelines drill-down (by pipeline name)') + + g.panel.row.withCollapsed(true) + + g.panel.row.withPanels( + [ + panels.pipelineRunsByNameChart { gridPos: { w: 24, h: 10 } }, + panels.topPipelinesByRunsTable { gridPos: { w: 8, h: 8 } }, + panels.topPipelinesByDurationTable { gridPos: { w: 8, h: 8 } }, + panels.topPipelinesByFailuresTable { gridPos: { w: 8, h: 8 } }, + panels.pipelineFreshnessByNameTable { gridPos: { w: 10, h: 10 } }, + panels.pipelineDurationByNameChart { gridPos: { w: 14, h: 10 } }, + ] + ), + + // SQL (Warehouses & Queries) Dashboard Rows + sqlbiStatistics: + g.panel.row.new('SQL warehouse overview') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.queriesTotalStat { gridPos: { w: 3, h: 4 } }, + panels.queryErrorRateStat { gridPos: { w: 3, h: 4 } }, + panels.queryP95LatencyStat { gridPos: { w: 3, h: 4 } }, + panels.concurrencyCurrentStat { gridPos: { w: 3, h: 4 } }, + panels.concurrencyBaseline7dStat { gridPos: { w: 4, h: 4 } }, + panels.dodQueriesDiffStat { gridPos: { w: 4, h: 4 } }, + panels.dodP95LatencyDiffStat { gridPos: { w: 4, h: 4 } }, + ] + ), + + sqlbiLoadAndLatency: + g.panel.row.new('Load & latency') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.queryLoadChart { gridPos: { w: 12, h: 8 } }, + panels.latencyP50P95Chart { gridPos: { w: 12, h: 8 } }, + ] + ), + + sqlbiErrorsAndConcurrency: + g.panel.row.new('Errors, concurrency & workspace distribution') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.sqlErrorRateChart { gridPos: { w: 8, h: 8 } }, + panels.concurrencyVsLatencyChart { gridPos: { w: 8, h: 8 } }, + panels.queriesByWorkspaceChart { gridPos: { w: 8, h: 8 } }, + ] + ), + + sqlbiTopWarehouses: + g.panel.row.new('Top warehouses') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.topWarehousesByQueriesTable { gridPos: { w: 8, h: 8 } }, + panels.topWarehousesByErrorsTable { gridPos: { w: 8, h: 8 } }, + panels.topWarehousesByLatencyTable { gridPos: { w: 8, h: 8 } }, + ] + ), + + sqlbiDistribution: + g.panel.row.new('Distribution & trends') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.queryLatencyDistribution { gridPos: { w: 8, h: 8 } }, + panels.medianLatencyVs7dChart { gridPos: { w: 8, h: 8 } }, + panels.dodChangesChart { gridPos: { w: 8, h: 8 } }, + ] + ), + + sqlbiWarehouseDrilldown: + g.panel.row.new('Performance by warehouse') + + g.panel.row.withCollapsed(false) + + g.panel.row.withPanels( + [ + panels.queriesByWarehouseChart { gridPos: { w: 6, h: 8 } }, + panels.queryErrorsByWarehouseChart { gridPos: { w: 6, h: 8 } }, + panels.queryLatencyByWarehouseChart { gridPos: { w: 6, h: 8 } }, + panels.concurrencyByWarehouseChart { gridPos: { w: 6, h: 8 } }, + ] + ), + }, +} diff --git a/mixin/signals/jobs_and_pipelines.libsonnet b/mixin/signals/jobs_and_pipelines.libsonnet new file mode 100644 index 0000000..9ef7fd8 --- /dev/null +++ b/mixin/signals/jobs_and_pipelines.libsonnet @@ -0,0 +1,398 @@ +function(this) { + local legendCustomTemplate = '{{instance}} - {{workspace_id}}', + local aggregationLabels = std.join(',', this.groupLabels + this.instanceLabels), + filteringSelector: this.filteringSelector, + groupLabels: this.groupLabels, + instanceLabels: this.instanceLabels, + legendCustomTemplate: legendCustomTemplate, + aggLevel: 'none', + aggFunction: 'avg', + signals: { + jobRunP95Aggregate: { + name: 'Job run p95 duration (aggregate)', + nameShort: 'Job p95 (all)', + description: 'Aggregate p95 job run duration across all jobs (max p95).', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max(databricks_job_run_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Jobs p95', + }, + }, + }, + + jobStatusBreakdown: { + name: 'Job status breakdown', + nameShort: 'Job status', + description: 'Job status counts by job name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_job_run_status_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}} - {{status}}', + }, + }, + }, + + jobFailures: { + name: 'Job failures', + nameShort: 'Job failures', + description: 'Number of failed job runs.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_job_run_status_sliding{%(queriesSelector)s, status=~"FAILED|ERROR"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}}', + }, + }, + }, + + jobSuccessRate: { + name: 'Job success rate', + nameShort: 'Success %', + description: 'Percentage of successful jobs.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum(databricks_job_run_status_sliding{%(queriesSelector)s, status="SUCCEEDED"}) + / + sum(databricks_job_run_status_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: 'Success rate', + }, + }, + }, + + pipelineRunP95Aggregate: { + name: 'Pipeline run p95 duration (aggregate)', + nameShort: 'Pipeline p95 (all)', + description: 'Aggregate p95 pipeline run duration across all pipelines (max p95).', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max(databricks_pipeline_run_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Pipelines p95', + }, + }, + }, + + pipelineStatusBreakdown: { + name: 'Pipeline status breakdown', + nameShort: 'Pipeline status', + description: 'Pipeline status counts by pipeline name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_pipeline_run_status_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}} - {{status}}', + }, + }, + }, + + pipelineFailures: { + name: 'Pipeline failures', + nameShort: 'Pipeline failures', + description: 'Number of failed pipeline runs.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_pipeline_run_status_sliding{%(queriesSelector)s, status="FAILED"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}}', + }, + }, + }, + + pipelineSuccessRate: { + name: 'Pipeline success rate', + nameShort: 'Success %', + description: 'Percentage of successful pipelines.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum(databricks_pipeline_run_status_sliding{%(queriesSelector)s, status="COMPLETED"}) + / + sum(databricks_pipeline_run_status_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: 'Success rate', + }, + }, + }, + + jobsThroughput: { + name: 'Jobs throughput', + nameShort: 'Jobs', + description: 'Total job runs in the sliding window.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (' + aggregationLabels + ') (databricks_job_runs_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Jobs', + }, + }, + }, + + pipelinesThroughput: { + name: 'Pipelines throughput', + nameShort: 'Pipelines', + description: 'Total pipeline runs in the sliding window.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (' + aggregationLabels + ') (databricks_pipeline_runs_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Pipelines', + }, + }, + }, + + jobFailureRate: { + name: 'Job failure rate', + nameShort: 'Job failures', + description: 'Job failure rate by workspace.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum by (workspace_id) (databricks_job_run_status_sliding{%(queriesSelector)s, status=~"FAILED|ERROR"}) + / + sum by (workspace_id) (databricks_job_run_status_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { queriesSelector: '%(queriesSelector)s' }, + legendCustomTemplate: '{{workspace_id}} - Jobs', + }, + }, + }, + + pipelineFailureRate: { + name: 'Pipeline failure rate', + nameShort: 'Pipeline failures', + description: 'Pipeline failure rate by workspace.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum by (workspace_id) (databricks_pipeline_run_status_sliding{%(queriesSelector)s, status="FAILED"}) + / + sum by (workspace_id) (databricks_pipeline_run_status_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { queriesSelector: '%(queriesSelector)s' }, + legendCustomTemplate: '{{workspace_id}} - Pipelines', + }, + }, + }, + + taskRetries: { + name: 'Task retries', + nameShort: 'Task retries', + description: 'Number of task retries.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_task_retries_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}} - Task retries', + }, + }, + }, + + pipelineRetries: { + name: 'Pipeline retries', + nameShort: 'Pipeline retries', + description: 'Number of pipeline retries.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_pipeline_retry_events_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}} - Pipeline retries', + }, + }, + }, + + jobFailuresByName: { + name: 'Job failures by job name', + nameShort: 'Job failures', + description: 'Number of failed job runs by job name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_job_run_status_sliding{%(queriesSelector)s, status=~"ERROR|FAILED|CANCELLED"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}}', + }, + }, + }, + + jobDurationByName: { + name: 'Job duration by job name', + nameShort: 'Job duration', + description: 'Job p95 duration by job name.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'databricks_job_run_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}} (p95)', + }, + }, + }, + + pipelineFailuresByName: { + name: 'Pipeline failures by pipeline name', + nameShort: 'Pipeline failures', + description: 'Number of failed pipeline runs by pipeline name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_pipeline_run_status_sliding{%(queriesSelector)s, status="FAILED"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}}', + }, + }, + }, + + pipelineDurationByName: { + name: 'Pipeline duration by pipeline name', + nameShort: 'Pipeline duration', + description: 'Pipeline p95 duration by pipeline name.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'databricks_pipeline_run_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}} (p95)', + }, + }, + }, + + pipelineFreshnessByName: { + name: 'Pipeline freshness lag by pipeline name', + nameShort: 'Freshness lag', + description: 'Data freshness lag by pipeline name.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'databricks_pipeline_freshness_lag_seconds_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}}', + }, + }, + }, + + // DEDICATED SIGNALS FOR SPECIFIC PANELS - DO NOT REUSE + // These are created to avoid breaking panels repeatedly due to sparse counter issues + + topJobsByRunsTableSignal: { + name: 'Top jobs by runs (table)', + nameShort: 'Top jobs', + description: 'Jobs ranked by total run count (sliding window gauge).', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id, job_id, job_name) (databricks_job_runs_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}}', + }, + }, + }, + + taskRetriesByJobTableSignal: { + name: 'Task retries by job (table)', + nameShort: 'Task retries', + description: 'Task retries aggregated by job (sliding window gauge).', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (job_id, job_name, task_key) (databricks_task_retries_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}} / {{task_key}}', + }, + }, + }, + + jobRunsByNameChartSignal: { + name: 'Job runs by name (chart)', + nameShort: 'Job runs', + description: 'Job runs by job name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_job_runs_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{job_name}}', + }, + }, + }, + + topPipelinesByRunsTableSignal: { + name: 'Top pipelines by runs (table)', + nameShort: 'Top pipelines', + description: 'Pipelines ranked by total run count (sliding window gauge).', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id, pipeline_id, pipeline_name) (databricks_pipeline_runs_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}}', + }, + }, + }, + + pipelineRunsByNameChartSignal: { + name: 'Pipeline runs by name (chart)', + nameShort: 'Pipeline runs', + description: 'Pipeline runs by pipeline name.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_pipeline_runs_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{pipeline_name}}', + }, + }, + }, + }, +} diff --git a/mixin/signals/overview.libsonnet b/mixin/signals/overview.libsonnet new file mode 100644 index 0000000..7e2cfeb --- /dev/null +++ b/mixin/signals/overview.libsonnet @@ -0,0 +1,163 @@ +function(this) { + local legendCustomTemplate = '{{instance}} - {{workspace_id}}', + local aggregationLabels = std.join(',', this.groupLabels + this.instanceLabels), + filteringSelector: this.filteringSelector, + groupLabels: this.groupLabels, + instanceLabels: this.instanceLabels, + enableLokiLogs: false, + legendCustomTemplate: legendCustomTemplate, + aggLevel: 'none', + aggFunction: 'avg', + alertsInterval: '5m', + discoveryMetric: { + prometheus: 'databricks_billing_dbus_sliding', + }, + signals: { + billingDbusTotal: { + name: 'Billing DBUs total', + nameShort: 'DBUs', + description: 'Databricks units (DBUs) consumed per workspace × SKU. Data reflects usage from 24-48 hours ago due to Databricks system table lag.', + type: 'gauge', + unit: 'none', // would be 'dbu' but no custom unit available + sources: { + prometheus: { + expr: 'databricks_billing_dbus_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}} - {{sku_name}}', + }, + }, + }, + + billingCostEstimateUsd: { + name: 'Billing cost estimate USD', + nameShort: 'Cost ($)', + description: 'List-price cost estimate (DBUs × list price). Data reflects usage from 24-48 hours ago due to Databricks system table lag.', + type: 'gauge', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: 'databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}} - {{sku_name}}', + }, + }, + }, + + yesterdayCost: { + name: 'Total cost (24h window)', + nameShort: 'Cost $', + description: 'Total cost estimate for the 24h window. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'raw', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: 'sum(databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s})', + legendCustomTemplate: 'Cost', + }, + }, + }, + + dodCostDelta: { + name: 'Cost change (vs 24h ago)', + nameShort: '24h Δ%', + description: 'Percentage change comparing current 24h window to the previous. Note: Due to 24-48h billing lag, this reflects historical trends.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + ( + sum(databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s}) + - + sum(databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s} offset 24h) + ) + / + sum(databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s} offset 24h) + ||| % { + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: '24h change', + }, + }, + }, + + totalDbusConsumed: { + name: 'Total DBUs (24h window)', + nameShort: 'DBUs', + description: 'Total DBUs consumed in 24h window. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'raw', + unit: 'none', // would be 'dbu' but no custom unit available + sources: { + prometheus: { + expr: 'sum(databricks_billing_dbus_sliding{%(queriesSelector)s})', + legendCustomTemplate: 'DBUs', + }, + }, + }, + + costBySku: { + name: 'Cost by SKU', + nameShort: 'Cost by SKU', + description: 'Cost breakdown by SKU over time. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'gauge', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: 'sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{sku_name}}', + }, + }, + }, + + costPerDbuBySku: { + name: 'Cost per DBU by SKU', + nameShort: 'Cost/DBU', + description: 'Cost efficiency per DBU by SKU. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'gauge', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s}) + / + sum by (sku_name) (databricks_billing_dbus_sliding{%(queriesSelector)s}) + )[30m:]) + |||, + legendCustomTemplate: '{{sku_name}}', + }, + }, + }, + + topWorkspacesByCost: { + name: 'Top workspaces by cost (24h window)', + nameShort: 'Top workspaces', + description: 'Workspaces with highest costs in 24h window. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'gauge', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: 'sum by (workspace_id) (databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}}', + }, + }, + }, + + topSkusByCost: { + name: 'Top SKUs by cost (24h window)', + nameShort: 'Top SKUs', + description: 'SKUs with highest costs in 24h window. Note: Data reflects usage from 24-48 hours ago due to Databricks billing lag.', + type: 'gauge', + unit: 'currencyUSD', + sources: { + prometheus: { + expr: 'sum by (sku_name) (databricks_billing_cost_estimate_usd_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{sku_name}}', + }, + }, + }, + }, +} diff --git a/mixin/signals/warehouses_and_queries.libsonnet b/mixin/signals/warehouses_and_queries.libsonnet new file mode 100644 index 0000000..1d3f23e --- /dev/null +++ b/mixin/signals/warehouses_and_queries.libsonnet @@ -0,0 +1,346 @@ +function(this) { + local legendCustomTemplate = '{{instance}} - {{workspace_id}}', + local aggregationLabels = std.join(',', this.groupLabels + this.instanceLabels), + filteringSelector: this.filteringSelector, + groupLabels: this.groupLabels, + instanceLabels: this.instanceLabels, + legendCustomTemplate: legendCustomTemplate, + aggLevel: 'none', + aggFunction: 'avg', + signals: { + queryDuration: { + name: 'Query duration (p95)', + nameShort: 'Query p95 duration', + description: 'Query duration (p95 by warehouse).', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max by (warehouse_id) (databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Warehouse - {{warehouse_id}}', + }, + }, + }, + + queryErrors: { + name: 'Query errors', + nameShort: 'Errors', + description: 'Query errors.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id) (databricks_query_errors_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}}', + }, + }, + }, + + queryLoad: { + name: 'Query load', + nameShort: 'Queries', + description: 'Total queries in the sliding window.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (' + aggregationLabels + ') (databricks_queries_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Queries', + }, + }, + }, + + queryErrorRateAggregate: { + name: 'Query error rate (aggregate)', + nameShort: 'Error %', + description: 'Aggregate query error percentage across all workspaces.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum(databricks_query_errors_sliding{%(queriesSelector)s}) + / + sum(databricks_queries_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: 'Error rate %%', + }, + }, + }, + + queryP95Latency: { + name: 'Query p95 latency (max)', + nameShort: 'p95 latency (max)', + description: 'Maximum p95 query latency across all warehouses.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max(databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'p95 latency', + }, + }, + }, + + queryP50Latency: { + name: 'Query p50 latency (max)', + nameShort: 'p50 latency (max)', + description: 'Maximum p50 query latency across all warehouses.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max(databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.50"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Current p50', + }, + }, + }, + + queryP50Latency7dBaseline: { + name: 'Query p50 latency (7d baseline)', + nameShort: 'p50 7d baseline', + description: '7-day rolling median baseline for p50 query latency.', + type: 'raw', + unit: 's', + sources: { + prometheus: { + expr: 'max(quantile_over_time(0.5, databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.50"}[7d]))', + legendCustomTemplate: '7 days median', + }, + }, + }, + + concurrencyCurrent: { + name: 'Total queries running (max)', + nameShort: 'Total queries running (max)', + description: 'Maximum number of concurrent queries across all warehouses.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'max(databricks_queries_running_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: 'Total queries running', + }, + }, + }, + + concurrencyBaseline: { + name: 'Max concurrent queries (7d p95)', + nameShort: 'Concurrency 7d p95', + description: 'Maximum baseline concurrency over 7 days (p95).', + type: 'raw', + unit: 'short', + sources: { + prometheus: { + expr: 'max(quantile_over_time(0.95, databricks_queries_running_sliding{%(queriesSelector)s}[7d]))', + legendCustomTemplate: '7d baseline', + }, + }, + }, + + dodQueriesDelta: { + name: 'DoD queries delta', + nameShort: 'DoD Queries Δ%', + description: 'Day-over-day change in query count (D-1 vs D-2).', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + ( + sum by (%(aggregationLabels)s) (databricks_queries_sliding{%(queriesSelector)s} offset 1d) + - + sum by (%(aggregationLabels)s) (databricks_queries_sliding{%(queriesSelector)s} offset 2d) + ) + / + sum by (%(aggregationLabels)s) (databricks_queries_sliding{%(queriesSelector)s} offset 2d) + )[30m:]) + ||| % { + aggregationLabels: aggregationLabels, + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: 'DoD', + }, + }, + }, + + dodP95LatencyDelta: { + name: 'DoD p95 latency delta (max)', + nameShort: 'DoD p95 Δ%', + description: 'Maximum day-over-day change in p95 query latency across all warehouses (D-1 vs D-2).', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + max( + ( + avg_over_time(databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}[1d] offset 1d) + - + avg_over_time(databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}[1d] offset 2d) + ) + / + avg_over_time(databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}[1d] offset 2d) + ) + ||| % { queriesSelector: '%(queriesSelector)s' }, + legendCustomTemplate: 'DoD p95 (max)', + }, + }, + }, + + queryErrorRate: { + name: 'Query error rate', + nameShort: 'Error rate', + description: 'SQL error percentage.', + type: 'raw', + unit: 'percentunit', + sources: { + prometheus: { + expr: ||| + last_over_time(( + sum by (%(aggregationLabels)s) (databricks_query_errors_sliding{%(queriesSelector)s}) + / + sum by (%(aggregationLabels)s) (databricks_queries_sliding{%(queriesSelector)s}) + )[30m:]) + ||| % { + aggregationLabels: aggregationLabels, + queriesSelector: '%(queriesSelector)s', + }, + legendCustomTemplate: '{{workspace_id}} - Error rate %%', + }, + }, + }, + + queriesByWorkspace: { + name: 'Queries by workspace', + nameShort: 'By workspace', + description: 'Query volume by workspace.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id) (databricks_queries_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{workspace_id}}', + }, + }, + }, + + // Detailed drill-down signals by warehouse_id + topWarehousesByQueries: { + name: 'Top warehouses by queries', + nameShort: 'Top by queries', + description: 'Warehouses ranked by total query volume (sliding window gauge).', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id, warehouse_id) (databricks_queries_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + topWarehousesByErrors: { + name: 'Top warehouses by errors', + nameShort: 'Top by errors', + description: 'Warehouses ranked by total error count (sliding window gauge).', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'sum by (workspace_id, warehouse_id) (databricks_query_errors_sliding{%(queriesSelector)s})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + topWarehousesByLatency: { + name: 'Top warehouses by p95 latency', + nameShort: 'Top by latency', + description: 'Warehouses ranked by p95 query latency (current gauge value).', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'max by (warehouse_id) (databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"})', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + queriesByWarehouse: { + name: 'Queries by warehouse (time series)', + nameShort: 'By warehouse', + description: 'Query volume by warehouse.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_queries_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + queryErrorsByWarehouse: { + name: 'Query errors by warehouse (time series)', + nameShort: 'Errors by warehouse', + description: 'Query errors by warehouse.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_query_errors_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + queryLatencyByWarehouse: { + name: 'Query latency by warehouse (time series)', + nameShort: 'Latency by warehouse', + description: 'Query p95 latency over time by warehouse.', + type: 'gauge', + unit: 's', + sources: { + prometheus: { + expr: 'databricks_query_duration_seconds_sliding{%(queriesSelector)s, quantile="0.95"}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + + concurrencyByWarehouse: { + name: 'Concurrency by warehouse', + nameShort: 'Concurrency by warehouse', + description: 'Concurrent queries by warehouse.', + type: 'gauge', + unit: 'short', + sources: { + prometheus: { + expr: 'databricks_queries_running_sliding{%(queriesSelector)s}', + exprWrappers: [['last_over_time(', '[30m:])']], + legendCustomTemplate: '{{warehouse_id}}', + }, + }, + }, + }, +} diff --git a/mixin/vendor/common-lib b/mixin/vendor/common-lib new file mode 120000 index 0000000..5d4320e --- /dev/null +++ b/mixin/vendor/common-lib @@ -0,0 +1 @@ +github.com/grafana/jsonnet-libs/common-lib \ No newline at end of file diff --git a/mixin/vendor/doc-util b/mixin/vendor/doc-util new file mode 120000 index 0000000..dcfde67 --- /dev/null +++ b/mixin/vendor/doc-util @@ -0,0 +1 @@ +github.com/jsonnet-libs/docsonnet/doc-util \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alert_condition.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alert_condition.libsonnet new file mode 100644 index 0000000..163d082 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alert_condition.libsonnet @@ -0,0 +1,47 @@ +{ + /** + * Returns a new condition of alert of graph panel. + * Currently the only condition type that exists is a Query condition + * that allows to specify a query letter, time range and an aggregation function. + * + * @name alertCondition.new + * + * @param evaluatorParams Value of threshold + * @param evaluatorType Type of threshold + * @param operatorType Operator between conditions + * @param queryRefId The letter defines what query to execute from the Metrics tab + * @param queryTimeStart Begging of time range + * @param queryTimeEnd End of time range + * @param reducerParams Params of an aggregation function + * @param reducerType Name of an aggregation function + * + * @return A json that represents a condition of alert + */ + new( + evaluatorParams=[], + evaluatorType='gt', + operatorType='and', + queryRefId='A', + queryTimeEnd='now', + queryTimeStart='5m', + reducerParams=[], + reducerType='avg', + ):: + { + evaluator: { + params: if std.type(evaluatorParams) == 'array' then evaluatorParams else [evaluatorParams], + type: evaluatorType, + }, + operator: { + type: operatorType, + }, + query: { + params: [queryRefId, queryTimeStart, queryTimeEnd], + }, + reducer: { + params: if std.type(reducerParams) == 'array' then reducerParams else [reducerParams], + type: reducerType, + }, + type: 'query', + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alertlist.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alertlist.libsonnet new file mode 100644 index 0000000..94df360 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/alertlist.libsonnet @@ -0,0 +1,43 @@ +{ + /** + * Creates an [Alert list panel](https://grafana.com/docs/grafana/latest/panels/visualizations/alert-list-panel/) + * + * @name alertlist.new + * + * @param title (default `''`) + * @param span (optional) + * @param show (default `'current'`) Whether the panel should display the current alert state or recent alert state changes. + * @param limit (default `10`) Sets the maximum number of alerts to list. + * @param sortOrder (default `'1'`) '1': alerting, '2': no_data, '3': pending, '4': ok, '5': paused + * @param stateFilter (optional) + * @param onlyAlertsOnDashboard (optional) Shows alerts only from the dashboard the alert list is in + * @param transparent (optional) Whether to display the panel without a background + * @param description (optional) + * @param datasource (optional) + */ + new( + title='', + span=null, + show='current', + limit=10, + sortOrder=1, + stateFilter=[], + onlyAlertsOnDashboard=true, + transparent=null, + description=null, + datasource=null, + ):: + { + [if transparent != null then 'transparent']: transparent, + title: title, + [if span != null then 'span']: span, + type: 'alertlist', + show: show, + limit: limit, + sortOrder: sortOrder, + [if show != 'changes' then 'stateFilter']: stateFilter, + onlyAlertsOnDashboard: onlyAlertsOnDashboard, + [if description != null then 'description']: description, + datasource: datasource, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/annotation.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/annotation.libsonnet new file mode 100644 index 0000000..955b029 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/annotation.libsonnet @@ -0,0 +1,40 @@ +{ + default:: + { + builtIn: 1, + datasource: '-- Grafana --', + enable: true, + hide: true, + iconColor: 'rgba(0, 211, 255, 1)', + name: 'Annotations & Alerts', + type: 'dashboard', + }, + + /** + * @name annotation.datasource + */ + + datasource( + name, + datasource, + expr=null, + enable=true, + hide=false, + iconColor='rgba(255, 96, 96, 1)', + tags=[], + type='tags', + builtIn=null, + ):: + { + datasource: datasource, + enable: enable, + [if expr != null then 'expr']: expr, + hide: hide, + iconColor: iconColor, + name: name, + showIn: 0, + tags: tags, + type: type, + [if builtIn != null then 'builtIn']: builtIn, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/bar_gauge_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/bar_gauge_panel.libsonnet new file mode 100644 index 0000000..313e5a0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/bar_gauge_panel.libsonnet @@ -0,0 +1,47 @@ +{ + /** + * Create a [bar gauge panel](https://grafana.com/docs/grafana/latest/panels/visualizations/bar-gauge-panel/), + * + * @name barGaugePanel.new + * + * @param title Panel title. + * @param description (optional) Panel description. + * @param datasource (optional) Panel datasource. + * @param unit (optional) The unit of the data. + * @param thresholds (optional) An array of threashold values. + * + * @method addTarget(target) Adds a target object. + * @method addTargets(targets) Adds an array of targets. + */ + new( + title, + description=null, + datasource=null, + unit=null, + thresholds=[], + ):: { + type: 'bargauge', + title: title, + [if description != null then 'description']: description, + datasource: datasource, + targets: [ + ], + fieldConfig: { + defaults: { + unit: unit, + thresholds: { + mode: 'absolute', + steps: thresholds, + }, + }, + }, + _nextTarget:: 0, + addTarget(target):: self { + // automatically ref id in added targets. + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudmonitoring.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudmonitoring.libsonnet new file mode 100644 index 0000000..49cef5e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudmonitoring.libsonnet @@ -0,0 +1,57 @@ +{ + /** + * Creates a [Google Cloud Monitoring target](https://grafana.com/docs/grafana/latest/datasources/google-cloud-monitoring/) + * + * @name cloudmonitoring.target + * + * @param metric + * @param project + * @param filters (optional) + * @param groupBys (optional) + * @param period (default: `'cloud-monitoring-auto'`) + * @param crossSeriesReducer (default 'REDUCE_MAX') + * @param valueType (default 'INT64') + * @param perSeriesAligner (default 'ALIGN_DELTA') + * @param metricKind (default 'CUMULATIVE') + * @param unit (optional) + * @param alias (optional) + + * @return Panel target + */ + + target( + metric, + project, + filters=[], + groupBys=[], + period='cloud-monitoring-auto', + crossSeriesReducer='REDUCE_MAX', + valueType='INT64', + perSeriesAligner='ALIGN_DELTA', + metricKind='CUMULATIVE', + unit=1, + alias=null, + ):: { + metricQuery: { + [if alias != null then 'aliasBy']: alias, + alignmentPeriod: period, + crossSeriesReducer: crossSeriesReducer, + [if filters != null then 'filters']: filters, + [if groupBys != null then 'groupBys']: groupBys, + metricKind: metricKind, + metricType: metric, + perSeriesAligner: perSeriesAligner, + projectName: project, + unit: unit, + valueType: valueType, + }, + sloQuery: { + [if alias != null then 'aliasBy']: alias, + alignmentPeriod: period, + projectName: project, + selectorName: 'select_slo_health', + serviceId: '', + sloId: '', + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudwatch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudwatch.libsonnet new file mode 100644 index 0000000..f56056f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/cloudwatch.libsonnet @@ -0,0 +1,51 @@ +{ + /** + * Creates a [CloudWatch target](https://grafana.com/docs/grafana/latest/datasources/cloudwatch/) + * + * @name cloudwatch.target + * + * @param region + * @param namespace + * @param metric + * @param datasource (optional) + * @param statistic (default: `'Average'`) + * @param alias (optional) + * @param highResolution (default: `false`) + * @param period (default: `'auto'`) + * @param dimensions (optional) + * @param id (optional) + * @param expression (optional) + * @param hide (optional) + + * @return Panel target + */ + + target( + region, + namespace, + metric, + datasource=null, + statistic='Average', + alias=null, + highResolution=false, + period='auto', + dimensions={}, + id=null, + expression=null, + hide=null + ):: { + region: region, + namespace: namespace, + metricName: metric, + [if datasource != null then 'datasource']: datasource, + statistics: [statistic], + [if alias != null then 'alias']: alias, + highResolution: highResolution, + period: period, + dimensions: dimensions, + [if id != null then 'id']: id, + [if expression != null then 'expression']: expression, + [if hide != null then 'hide']: hide, + + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashboard.libsonnet new file mode 100644 index 0000000..1cc1bf3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashboard.libsonnet @@ -0,0 +1,181 @@ +local timepickerlib = import 'timepicker.libsonnet'; + +{ + /** + * Creates a [dashboard](https://grafana.com/docs/grafana/latest/features/dashboard/dashboards/) + * + * @name dashboard.new + * + * @param title The title of the dashboard + * @param editable (default: `false`) Whether the dashboard is editable via Grafana UI. + * @param style (default: `'dark'`) Theme of dashboard, `'dark'` or `'light'` + * @param tags (optional) Array of tags associated to the dashboard, e.g.`['tag1','tag2']` + * @param time_from (default: `'now-6h'`) + * @param time_to (default: `'now'`) + * @param timezone (default: `'browser'`) Timezone of the dashboard, `'utc'` or `'browser'` + * @param refresh (default: `''`) Auto-refresh interval, e.g. `'30s'` + * @param timepicker (optional) See timepicker API + * @param graphTooltip (default: `'default'`) `'default'` : no shared crosshair or tooltip (0), `'shared_crosshair'`: shared crosshair (1), `'shared_tooltip'`: shared crosshair AND shared tooltip (2) + * @param hideControls (default: `false`) + * @param schemaVersion (default: `14`) Version of the Grafana JSON schema, incremented each time an update brings changes. `26` for Grafana 7.1.5, `22` for Grafana 6.7.4, `16` for Grafana 5.4.5, `14` for Grafana 4.6.3. etc. + * @param uid (default: `''`) Unique dashboard identifier as a string (8-40), that can be chosen by users. Used to identify a dashboard to update when using Grafana REST API. + * @param description (optional) + * + * @method addTemplate(template) Add a template variable + * @method addTemplates(templates) Adds an array of template variables + * @method addAnnotation(annotation) Add an [annotation](https://grafana.com/docs/grafana/latest/dashboards/annotations/) + * @method addPanel(panel,gridPos) Appends a panel, with an optional grid position in grid coordinates, e.g. `gridPos={'x':0, 'y':0, 'w':12, 'h': 9}` + * @method addPanels(panels) Appends an array of panels + * @method addLink(link) Adds a [dashboard link](https://grafana.com/docs/grafana/latest/linking/dashboard-links/) + * @method addLinks(dashboardLink) Adds an array of [dashboard links](https://grafana.com/docs/grafana/latest/linking/dashboard-links/) + * @method addRequired(type, name, id, version) + * @method addInput(name, label, type, pluginId, pluginName, description, value) + * @method addRow(row) Adds a row. This is the legacy row concept from Grafana < 5, when rows were needed for layout. Rows should now be added via `addPanel`. + */ + new( + title, + editable=false, + style='dark', + tags=[], + time_from='now-6h', + time_to='now', + timezone='browser', + refresh='', + timepicker=timepickerlib.new(), + graphTooltip='default', + hideControls=false, + schemaVersion=14, + uid='', + description=null, + ):: { + local it = self, + _annotations:: [], + [if uid != '' then 'uid']: uid, + editable: editable, + [if description != null then 'description']: description, + gnetId: null, + graphTooltip: + if graphTooltip == 'shared_tooltip' then 2 + else if graphTooltip == 'shared_crosshair' then 1 + else if graphTooltip == 'default' then 0 + else graphTooltip, + hideControls: hideControls, + id: null, + links: [], + panels:: [], + refresh: refresh, + rows: [], + schemaVersion: schemaVersion, + style: style, + tags: tags, + time: { + from: time_from, + to: time_to, + }, + timezone: timezone, + timepicker: timepicker, + title: title, + version: 0, + addAnnotations(annotations):: self { + _annotations+:: annotations, + }, + addAnnotation(a):: self.addAnnotations([a]), + addTemplates(templates):: self { + templates+: templates, + }, + addTemplate(t):: self.addTemplates([t]), + templates:: [], + annotations: { list: it._annotations }, + templating: { list: it.templates }, + _nextPanel:: 2, + addRow(row):: + self { + // automatically number panels in added rows. + // https://github.com/kausalco/public/blob/master/klumps/grafana.libsonnet + local n = std.length(row.panels), + local nextPanel = super._nextPanel, + local panels = std.makeArray(n, function(i) + row.panels[i] { id: nextPanel + i }), + + _nextPanel: nextPanel + n, + rows+: [row { panels: panels }], + }, + addPanels(newpanels):: + self { + // automatically number panels in added rows. + // https://github.com/kausalco/public/blob/master/klumps/grafana.libsonnet + local n = std.foldl(function(numOfPanels, p) + (if 'panels' in p then + numOfPanels + 1 + std.length(p.panels) + else + numOfPanels + 1), newpanels, 0), + local nextPanel = super._nextPanel, + local _panels = std.makeArray( + std.length(newpanels), function(i) + newpanels[i] { + id: nextPanel + ( + if i == 0 then + 0 + else + if 'panels' in _panels[i - 1] then + (_panels[i - 1].id - nextPanel) + 1 + std.length(_panels[i - 1].panels) + else + (_panels[i - 1].id - nextPanel) + 1 + + ), + [if 'panels' in newpanels[i] then 'panels']: std.makeArray( + std.length(newpanels[i].panels), function(j) + newpanels[i].panels[j] { + id: 1 + j + + nextPanel + ( + if i == 0 then + 0 + else + if 'panels' in _panels[i - 1] then + (_panels[i - 1].id - nextPanel) + 1 + std.length(_panels[i - 1].panels) + else + (_panels[i - 1].id - nextPanel) + 1 + + ), + } + ), + } + ), + + _nextPanel: nextPanel + n, + panels+::: _panels, + }, + addPanel(panel, gridPos):: self.addPanels([panel { gridPos: gridPos }]), + addRows(rows):: std.foldl(function(d, row) d.addRow(row), rows, self), + addLink(link):: self { + links+: [link], + }, + addLinks(dashboardLinks):: std.foldl(function(d, t) d.addLink(t), dashboardLinks, self), + required:: [], + __requires: it.required, + addRequired(type, name, id, version):: self { + required+: [{ type: type, name: name, id: id, version: version }], + }, + inputs:: [], + __inputs: it.inputs, + addInput( + name, + label, + type, + pluginId=null, + pluginName=null, + description='', + value=null, + ):: self { + inputs+: [{ + name: name, + label: label, + type: type, + [if pluginId != null then 'pluginId']: pluginId, + [if pluginName != null then 'pluginName']: pluginName, + [if value != null then 'value']: value, + description: description, + }], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashlist.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashlist.libsonnet new file mode 100644 index 0000000..436cb02 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/dashlist.libsonnet @@ -0,0 +1,41 @@ +{ + /** + * Creates a [dashlist panel](https://grafana.com/docs/grafana/latest/panels/visualizations/dashboard-list-panel/). + * It requires the dashlist panel plugin in grafana, which is built-in. + * + * @name dashlist.new + * + * @param title The title of the dashlist panel. + * @param description (optional) Description of the panel + * @param query (optional) Query to search by + * @param tags (optional) Array of tag(s) to search by + * @param recent (default `true`) Displays recently viewed dashboards + * @param search (default `false`) Description of the panel + * @param starred (default `false`) Displays starred dashboards + * @param headings (default `true`) Chosen list selection(starred, recently Viewed, search) is shown as a heading + * @param limit (default `10`) Set maximum items in a list + * @return A json that represents a dashlist panel + */ + new( + title, + description=null, + query=null, + tags=[], + recent=true, + search=false, + starred=false, + headings=true, + limit=10, + ):: { + type: 'dashlist', + title: title, + query: if query != null then query else '', + tags: tags, + recent: recent, + search: search, + starred: starred, + headings: headings, + limit: limit, + [if description != null then 'description']: description, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/elasticsearch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/elasticsearch.libsonnet new file mode 100644 index 0000000..769e1c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/elasticsearch.libsonnet @@ -0,0 +1,51 @@ +{ + /** + * Creates an [Elasticsearch target](https://grafana.com/docs/grafana/latest/datasources/elasticsearch/) + * + * @name elasticsearch.target + * + * @param query + * @param timeField + * @param id (optional) + * @param datasource (optional) + * @param metrics (optional) + * @param bucketAggs (optional) + * @param alias (optional) + */ + target( + query, + timeField, + id=null, + datasource=null, + metrics=[{ + field: 'value', + id: null, + type: 'percentiles', + settings: { + percents: [ + '90', + ], + }, + }], + bucketAggs=[{ + field: 'timestamp', + id: null, + type: 'date_histogram', + settings: { + interval: '1s', + min_doc_count: 0, + trimEdges: 0, + }, + }], + alias=null, + ):: { + [if datasource != null then 'datasource']: datasource, + query: query, + id: id, + timeField: timeField, + bucketAggs: bucketAggs, + metrics: metrics, + alias: alias, + // TODO: generate bucket ids + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/gauge_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/gauge_panel.libsonnet new file mode 100644 index 0000000..40b3673 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/gauge_panel.libsonnet @@ -0,0 +1,211 @@ +{ + /** + * Creates a [gauge panel](https://grafana.com/docs/grafana/latest/panels/visualizations/gauge-panel/). + * + * @name gaugePanel.new + * + * @param title Panel title. + * @param description (optional) Panel description. + * @param transparent (default `false`) Whether to display the panel without a background. + * @param datasource (optional) Panel datasource. + * @param allValues (default `false`) Show all values instead of reducing to one. + * @param valueLimit (optional) Limit of values in all values mode. + * @param reducerFunction (default `'mean'`) Function to use to reduce values to when using single value. + * @param fields (default `''`) Fields that should be included in the panel. + * @param showThresholdLabels (default `false`) Render the threshold values around the gauge bar. + * @param showThresholdMarkers (default `true`) Render the thresholds as an outer bar. + * @param unit (default `'percent'`) Panel unit field option. + * @param min (optional) Leave empty to calculate based on all values. + * @param max (optional) Leave empty to calculate based on all values. + * @param decimals Number of decimal places to show. + * @param displayName Change the field or series name. + * @param noValue (optional) What to show when there is no value. + * @param thresholdsMode (default `'absolute'`) 'absolute' or 'percentage'. + * @param repeat (optional) Name of variable that should be used to repeat this panel. + * @param repeatDirection (default `'h'`) 'h' for horizontal or 'v' for vertical. + * @param repeatMaxPerRow (optional) Maximum panels per row in repeat mode. + * @param pluginVersion (default `'7'`) Plugin version the panel should be modeled for. This has been tested with the default, '7', and '6.7'. + * + * @method addTarget(target) Adds a target object. + * @method addTargets(targets) Adds an array of targets. + * @method addLink(link) Adds a [panel link](https://grafana.com/docs/grafana/latest/linking/panel-links/). Argument format: `{ title: 'Link Title', url: 'https://...', targetBlank: true }`. + * @method addLinks(links) Adds an array of links. + * @method addThreshold(step) Adds a threshold step. Argument format: `{ color: 'green', value: 0 }`. + * @method addThresholds(steps) Adds an array of threshold steps. + * @method addMapping(mapping) Adds a value mapping. + * @method addMappings(mappings) Adds an array of value mappings. + * @method addDataLink(link) Adds a data link. + * @method addDataLinks(links) Adds an array of data links. + * @param timeFrom (optional) + */ + new( + title, + description=null, + transparent=false, + datasource=null, + allValues=false, + valueLimit=null, + reducerFunction='mean', + fields='', + showThresholdLabels=false, + showThresholdMarkers=true, + unit='percent', + min=0, + max=100, + decimals=null, + displayName=null, + noValue=null, + thresholdsMode='absolute', + repeat=null, + repeatDirection='h', + repeatMaxPerRow=null, + timeFrom=null, + pluginVersion='7', + ):: { + + type: 'gauge', + title: title, + [if description != null then 'description']: description, + transparent: transparent, + datasource: datasource, + targets: [], + links: [], + [if repeat != null then 'repeat']: repeat, + [if repeat != null then 'repeatDirection']: repeatDirection, + [if repeat != null then 'repeatMaxPerRow']: repeatMaxPerRow, + [if timeFrom != null then 'timeFrom']: timeFrom, + + // targets + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + + // links + addLink(link):: self { + links+: [link], + }, + addLinks(links):: std.foldl(function(p, l) p.addLink(l), links, self), + + pluginVersion: pluginVersion, + } + ( + + if pluginVersion >= '7' then { + options: { + reduceOptions: { + values: allValues, + [if allValues && valueLimit != null then 'limit']: valueLimit, + calcs: [ + reducerFunction, + ], + fields: fields, + }, + showThresholdLabels: showThresholdLabels, + showThresholdMarkers: showThresholdMarkers, + }, + fieldConfig: { + defaults: { + unit: unit, + [if min != null then 'min']: min, + [if max != null then 'max']: max, + [if decimals != null then 'decimals']: decimals, + [if displayName != null then 'displayName']: displayName, + [if noValue != null then 'noValue']: noValue, + thresholds: { + mode: thresholdsMode, + steps: [], + }, + mappings: [], + links: [], + }, + }, + + // thresholds + addThreshold(step):: self { + fieldConfig+: { defaults+: { thresholds+: { steps+: [step] } } }, + }, + + // mappings + _nextMapping:: 0, + addMapping(mapping):: self { + local nextMapping = super._nextMapping, + _nextMapping: nextMapping + 1, + fieldConfig+: { defaults+: { mappings+: [mapping { id: nextMapping }] } }, + }, + + // data links + addDataLink(link):: self { + fieldConfig+: { defaults+: { links+: [link] } }, + }, + + // Overrides + addOverride( + matcher=null, + properties=null, + ):: self { + fieldConfig+: { + overrides+: [ + { + [if matcher != null then 'matcher']: matcher, + [if properties != null then 'properties']: properties, + }, + ], + }, + }, + addOverrides(overrides):: std.foldl(function(p, o) p.addOverride(o.matcher, o.properties), overrides, self), + } else { + + options: { + fieldOptions: { + values: allValues, + [if allValues && valueLimit != null then 'limit']: valueLimit, + calcs: [ + reducerFunction, + ], + fields: fields, + defaults: { + unit: unit, + [if min != null then 'min']: min, + [if max != null then 'max']: max, + [if decimals != null then 'decimals']: decimals, + [if displayName != null then 'displayName']: displayName, + [if noValue != null then 'noValue']: noValue, + thresholds: { + mode: thresholdsMode, + steps: [], + }, + mappings: [], + links: [], + }, + }, + showThresholdLabels: showThresholdLabels, + showThresholdMarkers: showThresholdMarkers, + }, + + // thresholds + addThreshold(step):: self { + options+: { fieldOptions+: { defaults+: { thresholds+: { steps+: [step] } } } }, + }, + + // mappings + _nextMapping:: 0, + addMapping(mapping):: self { + local nextMapping = super._nextMapping, + _nextMapping: nextMapping + 1, + options+: { fieldOptions+: { defaults+: { mappings+: [mapping { id: nextMapping }] } } }, + }, + + // data links + addDataLink(link):: self { + options+: { fieldOptions+: { defaults+: { links+: [link] } } }, + }, + } + ) + { + addThresholds(steps):: std.foldl(function(p, s) p.addThreshold(s), steps, self), + addMappings(mappings):: std.foldl(function(p, m) p.addMapping(m), mappings, self), + addDataLinks(links):: std.foldl(function(p, l) p.addDataLink(l), links, self), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/grafana.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/grafana.libsonnet new file mode 100644 index 0000000..b94ddf3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/grafana.libsonnet @@ -0,0 +1,32 @@ +{ + alertlist:: import 'alertlist.libsonnet', + dashboard:: import 'dashboard.libsonnet', + template:: import 'template.libsonnet', + text:: import 'text.libsonnet', + timepicker:: import 'timepicker.libsonnet', + row:: import 'row.libsonnet', + link:: import 'link.libsonnet', + annotation:: import 'annotation.libsonnet', + graphPanel:: import 'graph_panel.libsonnet', + logPanel:: import 'log_panel.libsonnet', + tablePanel:: import 'table_panel.libsonnet', + singlestat:: import 'singlestat.libsonnet', + pieChartPanel:: import 'pie_chart_panel.libsonnet', + influxdb:: import 'influxdb.libsonnet', + prometheus:: import 'prometheus.libsonnet', + loki:: import 'loki.libsonnet', + sql:: import 'sql.libsonnet', + graphite:: import 'graphite.libsonnet', + alertCondition:: import 'alert_condition.libsonnet', + cloudmonitoring:: import 'cloudmonitoring.libsonnet', + cloudwatch:: import 'cloudwatch.libsonnet', + elasticsearch:: import 'elasticsearch.libsonnet', + heatmapPanel:: import 'heatmap_panel.libsonnet', + dashlist:: import 'dashlist.libsonnet', + pluginlist:: import 'pluginlist.libsonnet', + gauge:: error 'gauge is removed, migrate to gaugePanel', + gaugePanel:: import 'gauge_panel.libsonnet', + barGaugePanel:: import 'bar_gauge_panel.libsonnet', + statPanel:: import 'stat_panel.libsonnet', + transformation:: import 'transformation.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graph_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graph_panel.libsonnet new file mode 100644 index 0000000..8727695 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graph_panel.libsonnet @@ -0,0 +1,313 @@ +{ + /** + * Creates a [graph panel](https://grafana.com/docs/grafana/latest/panels/visualizations/graph-panel/). + * It requires the graph panel plugin in grafana, which is built-in. + * + * @name graphPanel.new + * + * @param title The title of the graph panel. + * @param description (optional) The description of the panel + * @param span (optional) Width of the panel + * @param datasource (optional) Datasource + * @param fill (default `1`) , integer from 0 to 10 + * @param fillGradient (default `0`) , integer from 0 to 10 + * @param linewidth (default `1`) Line Width, integer from 0 to 10 + * @param decimals (optional) Override automatic decimal precision for legend and tooltip. If null, not added to the json output. + * @param decimalsY1 (optional) Override automatic decimal precision for the first Y axis. If null, use decimals parameter. + * @param decimalsY2 (optional) Override automatic decimal precision for the second Y axis. If null, use decimals parameter. + * @param min_span (optional) Min span + * @param format (default `short`) Unit of the Y axes + * @param formatY1 (optional) Unit of the first Y axis + * @param formatY2 (optional) Unit of the second Y axis + * @param min (optional) Min of the Y axes + * @param max (optional) Max of the Y axes + * @param maxDataPoints (optional) If the data source supports it, sets the maximum number of data points for each series returned. + * @param labelY1 (optional) Label of the first Y axis + * @param labelY2 (optional) Label of the second Y axis + * @param x_axis_mode (default `'time'`) X axis mode, one of [time, series, histogram] + * @param x_axis_values (default `'total'`) Chosen value of series, one of [avg, min, max, total, count] + * @param x_axis_buckets (optional) Restricts the x axis to this amount of buckets + * @param x_axis_min (optional) Restricts the x axis to display from this value if supplied + * @param x_axis_max (optional) Restricts the x axis to display up to this value if supplied + * @param lines (default `true`) Display lines + * @param points (default `false`) Display points + * @param pointradius (default `5`) Radius of the points, allowed values are 0.5 or [1 ... 10] with step 1 + * @param bars (default `false`) Display bars + * @param staircase (default `false`) Display line as staircase + * @param dashes (default `false`) Display line as dashes + * @param stack (default `false`) Whether to stack values + * @param repeat (optional) Name of variable that should be used to repeat this panel. + * @param repeatDirection (default `'h'`) 'h' for horizontal or 'v' for vertical. + * @param legend_show (default `true`) Show legend + * @param legend_values (default `false`) Show values in legend + * @param legend_min (default `false`) Show min in legend + * @param legend_max (default `false`) Show max in legend + * @param legend_current (default `false`) Show current in legend + * @param legend_total (default `false`) Show total in legend + * @param legend_avg (default `false`) Show average in legend + * @param legend_alignAsTable (default `false`) Show legend as table + * @param legend_rightSide (default `false`) Show legend to the right + * @param legend_sideWidth (optional) Legend width + * @param legend_sort (optional) Sort order of legend + * @param legend_sortDesc (optional) Sort legend descending + * @param aliasColors (optional) Define color mappings for graphs + * @param thresholds (optional) An array of graph thresholds + * @param logBase1Y (default `1`) Value of logarithm base of the first Y axis + * @param logBase2Y (default `1`) Value of logarithm base of the second Y axis + * @param transparent (default `false`) Whether to display the panel without a background. + * @param value_type (default `'individual'`) Type of tooltip value + * @param shared_tooltip (default `true`) Allow to group or spit tooltips on mouseover within a chart + * @param percentage (defaut: false) show as percentages + * @param interval (defaut: null) A lower limit for the interval. + + * + * @method addTarget(target) Adds a target object. + * @method addTargets(targets) Adds an array of targets. + * @method addSeriesOverride(override) + * @method addYaxis(format,min,max,label,show,logBase,decimals) Adds a Y axis to the graph + * @method addAlert(alert) Adds an alert + * @method addLink(link) Adds a [panel link](https://grafana.com/docs/grafana/latest/linking/panel-links/) + * @method addLinks(links) Adds an array of links. + */ + new( + title, + span=null, + fill=1, + fillGradient=0, + linewidth=1, + decimals=null, + decimalsY1=null, + decimalsY2=null, + description=null, + min_span=null, + format='short', + formatY1=null, + formatY2=null, + min=null, + max=null, + labelY1=null, + labelY2=null, + x_axis_mode='time', + x_axis_values='total', + x_axis_buckets=null, + x_axis_min=null, + x_axis_max=null, + lines=true, + datasource=null, + points=false, + pointradius=5, + bars=false, + staircase=false, + height=null, + nullPointMode='null', + dashes=false, + stack=false, + repeat=null, + repeatDirection=null, + sort=0, + show_xaxis=true, + legend_show=true, + legend_values=false, + legend_min=false, + legend_max=false, + legend_current=false, + legend_total=false, + legend_avg=false, + legend_alignAsTable=false, + legend_rightSide=false, + legend_sideWidth=null, + legend_hideEmpty=null, + legend_hideZero=null, + legend_sort=null, + legend_sortDesc=null, + aliasColors={}, + thresholds=[], + links=[], + logBase1Y=1, + logBase2Y=1, + transparent=false, + value_type='individual', + shared_tooltip=true, + percentage=false, + maxDataPoints=null, + time_from=null, + time_shift=null, + interval=null + ):: { + title: title, + [if span != null then 'span']: span, + [if min_span != null then 'minSpan']: min_span, + [if decimals != null then 'decimals']: decimals, + type: 'graph', + datasource: datasource, + targets: [ + ], + [if description != null then 'description']: description, + [if height != null then 'height']: height, + renderer: 'flot', + yaxes: [ + self.yaxe( + if formatY1 != null then formatY1 else format, + min, + max, + decimals=(if decimalsY1 != null then decimalsY1 else decimals), + logBase=logBase1Y, + label=labelY1 + ), + self.yaxe( + if formatY2 != null then formatY2 else format, + min, + max, + decimals=(if decimalsY2 != null then decimalsY2 else decimals), + logBase=logBase2Y, + label=labelY2 + ), + ], + xaxis: { + show: show_xaxis, + mode: x_axis_mode, + name: null, + values: if x_axis_mode == 'series' then [x_axis_values] else [], + buckets: if x_axis_mode == 'histogram' then x_axis_buckets else null, + [if x_axis_min != null then 'min']: x_axis_min, + [if x_axis_max != null then 'max']: x_axis_max, + }, + lines: lines, + fill: fill, + fillGradient: fillGradient, + linewidth: linewidth, + dashes: dashes, + dashLength: 10, + spaceLength: 10, + points: points, + pointradius: pointradius, + bars: bars, + stack: stack, + percentage: percentage, + [if maxDataPoints != null then 'maxDataPoints']: maxDataPoints, + legend: { + show: legend_show, + values: legend_values, + min: legend_min, + max: legend_max, + current: legend_current, + total: legend_total, + alignAsTable: legend_alignAsTable, + rightSide: legend_rightSide, + sideWidth: legend_sideWidth, + avg: legend_avg, + [if legend_hideEmpty != null then 'hideEmpty']: legend_hideEmpty, + [if legend_hideZero != null then 'hideZero']: legend_hideZero, + [if legend_sort != null then 'sort']: legend_sort, + [if legend_sortDesc != null then 'sortDesc']: legend_sortDesc, + }, + nullPointMode: nullPointMode, + steppedLine: staircase, + tooltip: { + value_type: value_type, + shared: shared_tooltip, + sort: if sort == 'decreasing' then 2 else if sort == 'increasing' then 1 else sort, + }, + timeFrom: time_from, + timeShift: time_shift, + [if interval != null then 'interval']: interval, + [if transparent == true then 'transparent']: transparent, + aliasColors: aliasColors, + repeat: repeat, + [if repeatDirection != null then 'repeatDirection']: repeatDirection, + seriesOverrides: [], + thresholds: thresholds, + links: links, + yaxe( + format='short', + min=null, + max=null, + label=null, + show=true, + logBase=1, + decimals=null, + ):: { + label: label, + show: show, + logBase: logBase, + min: min, + max: max, + format: format, + [if decimals != null then 'decimals']: decimals, + }, + _nextTarget:: 0, + addTarget(target):: self { + // automatically ref id in added targets. + // https://github.com/kausalco/public/blob/master/klumps/grafana.libsonnet + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + addSeriesOverride(override):: self { + seriesOverrides+: [override], + }, + resetYaxes():: self { + yaxes: [], + }, + addYaxis( + format='short', + min=null, + max=null, + label=null, + show=true, + logBase=1, + decimals=null, + ):: self { + yaxes+: [self.yaxe(format, min, max, label, show, logBase, decimals)], + }, + addAlert( + name, + executionErrorState='alerting', + forDuration='5m', + frequency='60s', + handler=1, + message='', + noDataState='no_data', + notifications=[], + alertRuleTags={}, + ):: self { + local it = self, + _conditions:: [], + alert: { + name: name, + conditions: it._conditions, + executionErrorState: executionErrorState, + 'for': forDuration, + frequency: frequency, + handler: handler, + noDataState: noDataState, + notifications: notifications, + message: message, + alertRuleTags: alertRuleTags, + }, + addCondition(condition):: self { + _conditions+: [condition], + }, + addConditions(conditions):: std.foldl(function(p, c) p.addCondition(c), conditions, it), + }, + addLink(link):: self { + links+: [link], + }, + addLinks(links):: std.foldl(function(p, t) p.addLink(t), links, self), + addOverride( + matcher=null, + properties=null, + ):: self { + fieldConfig+: { + overrides+: [ + { + [if matcher != null then 'matcher']: matcher, + [if properties != null then 'properties']: properties, + }, + ], + }, + }, + addOverrides(overrides):: std.foldl(function(p, o) p.addOverride(o.matcher, o.properties), overrides, self), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graphite.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graphite.libsonnet new file mode 100644 index 0000000..46a0113 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/graphite.libsonnet @@ -0,0 +1,29 @@ +{ + /** + * Creates a [Graphite target](https://grafana.com/docs/grafana/latest/datasources/graphite/) + * + * @name graphite.target + * + * @param target Graphite Query. Nested queries are possible by adding the query reference (refId). + * @param targetFull (optional) Expanding the @target. Used in nested queries. + * @param hide (default `false`) Disable query on graph. + * @param textEditor (default `false`) Enable raw query mode. + * @param datasource (optional) Datasource. + + * @return Panel target + */ + target( + target, + targetFull=null, + hide=false, + textEditor=false, + datasource=null, + ):: { + target: target, + hide: hide, + textEditor: textEditor, + + [if targetFull != null then 'targetFull']: targetFull, + [if datasource != null then 'datasource']: datasource, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/heatmap_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/heatmap_panel.libsonnet new file mode 100644 index 0000000..5e9a04c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/heatmap_panel.libsonnet @@ -0,0 +1,150 @@ +{ + /** + * Creates a [heatmap panel](https://grafana.com/docs/grafana/latest/panels/visualizations/heatmap/). + * Requires the heatmap panel plugin in Grafana, which is built-in. + * + * @name heatmapPanel.new + * + * @param title The title of the heatmap panel + * @param description (optional) Description of panel + * @param datasource (optional) Datasource + * @param min_span (optional) Min span + * @param span (optional) Width of the panel + * @param cards_cardPadding (optional) How much padding to put between bucket cards + * @param cards_cardRound (optional) How much rounding should be applied to the bucket card shape + * @param color_cardColor (default `'#b4ff00'`) Hex value of color used when color_colorScheme is 'opacity' + * @param color_colorScale (default `'sqrt'`) How to scale the color range, 'linear' or 'sqrt' + * @param color_colorScheme (default `'interpolateOranges'`) TODO: document + * @param color_exponent (default `0.5`) TODO: document + * @param color_max (optional) The value for the end of the color range + * @param color_min (optional) The value for the beginning of the color range + * @param color_mode (default `'spectrum'`) How to display difference in frequency with color + * @param dataFormat (default `'timeseries'`) How to format the data + * @param highlightCards (default `true`) TODO: document + * @param hideZeroBuckets (default `false`) Whether or not to hide empty buckets, default is false + * @param legend_show (default `false`) Show legend + * @param minSpan (optional) Minimum span of the panel when repeated on a template variable + * @param repeat (optional) Variable used to repeat the heatmap panel + * @param repeatDirection (optional) Which direction to repeat the panel, 'h' for horizontal and 'v' for vertically + * @param tooltipDecimals (optional) The number of decimal places to display in the tooltip + * @param tooltip_show (default `true`) Whether or not to display a tooltip when hovering over the heatmap + * @param tooltip_showHistogram (default `false`) Whether or not to display a histogram in the tooltip + * @param xAxis_show (default `true`) Whether or not to show the X axis, default true + * @param xBucketNumber (optional) Number of buckets for the X axis + * @param xBucketSize (optional) Size of X axis buckets. Number or interval(10s, 15h, etc.) Has priority over xBucketNumber + * @param yAxis_decimals (optional) Override automatic decimal precision for the Y axis + * @param yAxis_format (default `'short'`) Unit of the Y axis + * @param yAxis_logBase (default `1`) Only if dataFormat is 'timeseries' + * @param yAxis_min (optional) Only if dataFormat is 'timeseries', min of the Y axis + * @param yAxis_max (optional) Only if dataFormat is 'timeseries', max of the Y axis + * @param yAxis_show (default `true`) Whether or not to show the Y axis + * @param yAxis_splitFactor (optional) TODO: document + * @param yBucketBound (default `'auto'`) Which bound ('lower' or 'upper') of the bucket to use + * @param yBucketNumber (optional) Number of buckets for the Y axis + * @param yBucketSize (optional) Size of Y axis buckets. Has priority over yBucketNumber + * @param maxDataPoints (optional) The maximum data points per series. Used directly by some data sources and used in calculation of auto interval. With streaming data this value is used for the rolling buffer. + * + * @method addTarget(target) Adds a target object. + * @method addTargets(targets) Adds an array of targets. + */ + new( + title, + datasource=null, + description=null, + cards_cardPadding=null, + cards_cardRound=null, + color_cardColor='#b4ff00', + color_colorScale='sqrt', + color_colorScheme='interpolateOranges', + color_exponent=0.5, + color_max=null, + color_min=null, + color_mode='spectrum', + dataFormat='timeseries', + highlightCards=true, + hideZeroBuckets=false, + legend_show=false, + minSpan=null, + span=null, + repeat=null, + repeatDirection=null, + tooltipDecimals=null, + tooltip_show=true, + tooltip_showHistogram=false, + xAxis_show=true, + xBucketNumber=null, + xBucketSize=null, + yAxis_decimals=null, + yAxis_format='short', + yAxis_logBase=1, + yAxis_min=null, + yAxis_max=null, + yAxis_show=true, + yAxis_splitFactor=null, + yBucketBound='auto', + yBucketNumber=null, + yBucketSize=null, + maxDataPoints=null, + ):: { + title: title, + type: 'heatmap', + [if description != null then 'description']: description, + datasource: datasource, + cards: { + cardPadding: cards_cardPadding, + cardRound: cards_cardRound, + }, + color: { + mode: color_mode, + cardColor: color_cardColor, + colorScale: color_colorScale, + exponent: color_exponent, + [if color_mode == 'spectrum' then 'colorScheme']: color_colorScheme, + [if color_max != null then 'max']: color_max, + [if color_min != null then 'min']: color_min, + }, + [if dataFormat != null then 'dataFormat']: dataFormat, + heatmap: {}, + hideZeroBuckets: hideZeroBuckets, + highlightCards: highlightCards, + legend: { + show: legend_show, + }, + [if minSpan != null then 'minSpan']: minSpan, + [if span != null then 'span']: span, + [if repeat != null then 'repeat']: repeat, + [if repeatDirection != null then 'repeatDirection']: repeatDirection, + tooltip: { + show: tooltip_show, + showHistogram: tooltip_showHistogram, + }, + [if tooltipDecimals != null then 'tooltipDecimals']: tooltipDecimals, + xAxis: { + show: xAxis_show, + }, + xBucketNumber: if dataFormat == 'timeseries' && xBucketSize != null then xBucketNumber else null, + xBucketSize: if dataFormat == 'timeseries' && xBucketSize != null then xBucketSize else null, + yAxis: { + decimals: yAxis_decimals, + [if dataFormat == 'timeseries' then 'logBase']: yAxis_logBase, + format: yAxis_format, + [if dataFormat == 'timeseries' then 'max']: yAxis_max, + [if dataFormat == 'timeseries' then 'min']: yAxis_min, + show: yAxis_show, + splitFactor: yAxis_splitFactor, + }, + yBucketBound: yBucketBound, + [if dataFormat == 'timeseries' then 'yBucketNumber']: yBucketNumber, + [if dataFormat == 'timeseries' then 'yBucketSize']: yBucketSize, + [if maxDataPoints != null then 'maxDataPoints']: maxDataPoints, + + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + }, + +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/influxdb.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/influxdb.libsonnet new file mode 100644 index 0000000..dd7c4fd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/influxdb.libsonnet @@ -0,0 +1,104 @@ +{ + /** + * Creates an [InfluxDB target](https://grafana.com/docs/grafana/latest/datasources/influxdb/) + * + * @name influxdb.target + * + * @param query Raw InfluxQL statement + * + * @param alias (optional) 'Alias By' pattern + * @param datasource (optional) Datasource + * @param hide (optional) Disable query on graph + * + * @param rawQuery (optional) Enable/disable raw query mode + * + * @param policy (default: `'default'`) Tagged query 'From' policy + * @param measurement (optional) Tagged query 'From' measurement + * @param group_time (default: `'$__interval'`) 'Group by' time condition (if set to null, do not groups by time) + * @param group_tags (optional) 'Group by' tags list + * @param fill (default: `'none'`) 'Group by' missing values fill mode (works only with 'Group by time()') + * + * @param resultFormat (default: `'time_series'`) Format results as 'Time series' or 'Table' + * + * @return Panel target + */ + target( + query=null, + + alias=null, + datasource=null, + hide=null, + + rawQuery=null, + + policy='default', + measurement=null, + + group_time='$__interval', + group_tags=[], + fill='none', + + resultFormat='time_series', + ):: { + local it = self, + + [if alias != null then 'alias']: alias, + [if datasource != null then 'datasource']: datasource, + [if hide != null then 'hide']: hide, + + [if query != null then 'query']: query, + [if rawQuery != null then 'rawQuery']: rawQuery, + [if rawQuery == null && query != null then 'rawQuery']: true, + + policy: policy, + [if measurement != null then 'measurement']: measurement, + tags: [], + select: [], + groupBy: + if group_time != null then + [{ type: 'time', params: [group_time] }] + + [{ type: 'tag', params: [tag_name] } for tag_name in group_tags] + + [{ type: 'fill', params: [fill] }] + else + [{ type: 'tag', params: [tag_name] } for tag_name in group_tags], + + resultFormat: resultFormat, + + where(key, operator, value, condition=null):: self { + /* + * Adds query tag condition ('Where' section) + */ + tags: + if std.length(it.tags) == 0 then + [{ key: key, operator: operator, value: value }] + else + it.tags + [{ + key: key, + operator: operator, + value: value, + condition: if condition == null then 'AND' else condition, + }], + }, + + selectField(value):: self { + /* + * Adds InfluxDB selection ('field(value)' part of 'Select' statement) + */ + select+: [[{ params: [value], type: 'field' }]], + }, + + addConverter(type, params=[]):: self { + /* + * Appends converter (aggregation, selector, etc.) to last added selection + */ + local len = std.length(it.select), + select: + if len == 1 then + [it.select[0] + [{ params: params, type: type }]] + else if len > 1 then + it.select[0:(len - 1)] + [it.select[len - 1] + [{ params: params, type: type }]] + else + [], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/link.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/link.libsonnet new file mode 100644 index 0000000..5e5ebd2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/link.libsonnet @@ -0,0 +1,39 @@ +{ + /** + * Creates [links](https://grafana.com/docs/grafana/latest/linking/linking-overview/) to navigate to other dashboards. + * + * @param title Human-readable label for the link. + * @param tags Limits the linked dashboards to only the ones with the corresponding tags. Otherwise, Grafana includes links to all other dashboards. + * @param asDropdown (default: `true`) Whether to use a dropdown (with an optional title). If `false`, displays the dashboard links side by side across the top of dashboard. + * @param includeVars (default: `false`) Whether to include template variables currently used as query parameters in the link. Any matching templates in the linked dashboard are set to the values from the link + * @param keepTime (default: `false`) Whether to include the current dashboard time range in the link (e.g. from=now-3h&to=now) + * @param icon (default: `'external link'`) Icon displayed with the link. + * @param url (default: `''`) URL of the link + * @param targetBlank (default: `false`) Whether the link will open in a new window. + * @param type (default: `'dashboards'`) + * + * @name link.dashboards + */ + dashboards( + title, + tags, + asDropdown=true, + includeVars=false, + keepTime=false, + icon='external link', + url='', + targetBlank=false, + type='dashboards', + ):: + { + asDropdown: asDropdown, + icon: icon, + includeVars: includeVars, + keepTime: keepTime, + tags: tags, + title: title, + type: type, + url: url, + targetBlank: targetBlank, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/log_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/log_panel.libsonnet new file mode 100644 index 0000000..747ad5f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/log_panel.libsonnet @@ -0,0 +1,56 @@ +{ + /** + * Creates a [log panel](https://grafana.com/docs/grafana/latest/panels/visualizations/logs-panel/). + * It requires the log panel plugin in grafana, which is built-in. + * + * @name logPanel.new + * + * @param title (default `''`) The title of the log panel. + * @param span (optional) Width of the panel + * @param datasource (optional) Datasource + * @showLabels (default `false`) Whether to show or hide labels + * @showTime (default `true`) Whether to show or hide time for each line + * @wrapLogMessage (default `true`) Whether to wrap log line to the next line + * @sortOrder (default `'Descending'`) sort log by time (can be 'Descending' or 'Ascending' ) + * + * @method addTarget(target) Adds a target object + * @method addTargets(targets) Adds an array of targets + */ + new( + title='', + datasource=null, + time_from=null, + time_shift=null, + showLabels=false, + showTime=true, + sortOrder='Descending', + wrapLogMessage=true, + span=12, + height=null, + ):: { + [if height != null then 'height']: height, + span: span, + datasource: datasource, + options: { + showLabels: showLabels, + showTime: showTime, + sortOrder: sortOrder, + wrapLogMessage: wrapLogMessage, + }, + targets: [ + ], + _nextTarget:: 0, + addTarget(target):: self { + // automatically ref id in added targets. + // https://github.com/kausalco/public/blob/master/klumps/grafana.libsonnet + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + timeFrom: time_from, + timeShift: time_shift, + title: title, + type: 'logs', + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/loki.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/loki.libsonnet new file mode 100644 index 0000000..a300f5a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/loki.libsonnet @@ -0,0 +1,22 @@ +{ + /** + * Creates a [Loki target](https://grafana.com/docs/grafana/latest/datasources/loki/) + * + * @name loki.target + * + * @param expr + * @param hide (optional) Disable query on graph. + * @param legendFormat (optional) Defines the legend. Defaults to ''. + */ + target( + expr, + hide=null, + legendFormat='', + instant=null, + ):: { + [if hide != null then 'hide']: hide, + expr: expr, + legendFormat: legendFormat, + [if instant != null then 'instant']: instant, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pie_chart_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pie_chart_panel.libsonnet new file mode 100644 index 0000000..11719e1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pie_chart_panel.libsonnet @@ -0,0 +1,72 @@ +{ + /** + * Creates a pie chart panel. + * It requires the [pie chart panel plugin in grafana](https://grafana.com/grafana/plugins/grafana-piechart-panel), + * which needs to be explicitly installed. + * + * @name pieChartPanel.new + * + * @param title The title of the pie chart panel. + * @param description (default `''`) Description of the panel + * @param span (optional) Width of the panel + * @param min_span (optional) Min span + * @param datasource (optional) Datasource + * @param aliasColors (optional) Define color mappings + * @param pieType (default `'pie'`) Type of pie chart (one of pie or donut) + * @param showLegend (default `true`) Show legend + * @param showLegendPercentage (default `true`) Show percentage values in the legend + * @param legendType (default `'Right side'`) Type of legend (one of 'Right side', 'Under graph' or 'On graph') + * @param valueName (default `'current') Type of tooltip value + * @param repeat (optional) Variable used to repeat the pie chart + * @param repeatDirection (optional) Which direction to repeat the panel, 'h' for horizontal and 'v' for vertical + * @param maxPerRow (optional) Number of panels to display when repeated. Used in combination with repeat. + * @return A json that represents a pie chart panel + * + * @method addTarget(target) Adds a target object. + */ + new( + title, + description='', + span=null, + min_span=null, + datasource=null, + height=null, + aliasColors={}, + pieType='pie', + valueName='current', + showLegend=true, + showLegendPercentage=true, + legendType='Right side', + repeat=null, + repeatDirection=null, + maxPerRow=null, + ):: { + type: 'grafana-piechart-panel', + [if description != null then 'description']: description, + pieType: pieType, + title: title, + aliasColors: aliasColors, + [if span != null then 'span']: span, + [if min_span != null then 'minSpan']: min_span, + [if height != null then 'height']: height, + [if repeat != null then 'repeat']: repeat, + [if repeatDirection != null then 'repeatDirection']: repeatDirection, + [if maxPerRow != null then 'maxPerRow']: maxPerRow, + valueName: valueName, + datasource: datasource, + legend: { + show: showLegend, + values: true, + percentage: showLegendPercentage, + }, + legendType: legendType, + targets: [ + ], + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pluginlist.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pluginlist.libsonnet new file mode 100644 index 0000000..d3f23ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/pluginlist.libsonnet @@ -0,0 +1,23 @@ +{ + /** + * Returns a new pluginlist panel that can be added in a row. + * It requires the pluginlist panel plugin in grafana, which is built-in. + * + * @name pluginlist.new + * + * @param title The title of the pluginlist panel. + * @param description (optional) Description of the panel + * @param limit (optional) Set maximum items in a list + * @return A json that represents a pluginlist panel + */ + new( + title, + description=null, + limit=null, + ):: { + type: 'pluginlist', + title: title, + [if limit != null then 'limit']: limit, + [if description != null then 'description']: description, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/prometheus.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/prometheus.libsonnet new file mode 100644 index 0000000..46b75b0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/prometheus.libsonnet @@ -0,0 +1,38 @@ +{ + /** + * Creates a [Prometheus target](https://grafana.com/docs/grafana/latest/datasources/prometheus/) + * to be added to panels. + * + * @name prometheus.target + * + * @param expr PromQL query to be exercised against Prometheus. Checkout [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/querying/basics/). + * @param format (default `'time_series'`) Switch between `'table'`, `'time_series'` or `'heatmap'`. Table will only work in the Table panel. Heatmap is suitable for displaying metrics of the Histogram type on a Heatmap panel. Under the hood, it converts cumulative histograms to regular ones and sorts series by the bucket bound. + * @param intervalFactor (default `2`) + * @param legendFormat (default `''`) Controls the name of the time series, using name or pattern. For example `{{hostname}}` is replaced with the label value for the label `hostname`. + * @param datasource (optional) Name of the Prometheus datasource. Leave by default otherwise. + * @param interval (optional) Time span used to aggregate or group data points by time. By default Grafana uses an automatic interval calculated based on the width of the graph. + * @param instant (optional) Perform an "instant" query, to return only the latest value that Prometheus has scraped for the requested time series. Instant queries return results much faster than normal range queries. Use them to look up label sets. + * @param hide (optional) Set to `true` to hide the target from the panel. + * + * @return A Prometheus target to be added to panels. + */ + target( + expr, + format='time_series', + intervalFactor=2, + legendFormat='', + datasource=null, + interval=null, + instant=null, + hide=null, + ):: { + [if hide != null then 'hide']: hide, + [if datasource != null then 'datasource']: datasource, + expr: expr, + format: format, + intervalFactor: intervalFactor, + legendFormat: legendFormat, + [if interval != null then 'interval']: interval, + [if instant != null then 'instant']: instant, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/row.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/row.libsonnet new file mode 100644 index 0000000..b380192 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/row.libsonnet @@ -0,0 +1,47 @@ +{ + /** + * Creates a [row](https://grafana.com/docs/grafana/latest/features/dashboard/dashboards/#rows). + * Rows are logical dividers within a dashboard and used to group panels together. + * + * @name row.new + * + * @param title The title of the row. + * @param showTitle (default `true` if title is set) Whether to show the row title + * @paral titleSize (default `'h6'`) The size of the title + * @param collapse (default `false`) The initial state of the row when opening the dashboard. Panels in a collapsed row are not load until the row is expanded. + * @param repeat (optional) Name of variable that should be used to repeat this row. It is recommended to use the variable in the row title as well. + * + * @method addPanels(panels) Appends an array of nested panels + * @method addPanel(panel,gridPos) Appends a nested panel, with an optional grid position in grid coordinates, e.g. `gridPos={'x':0, 'y':0, 'w':12, 'h': 9}` + */ + new( + title='Dashboard Row', + height=null, + collapse=false, + repeat=null, + showTitle=null, + titleSize='h6' + ):: { + collapse: collapse, + collapsed: collapse, + [if height != null then 'height']: height, + panels: [], + repeat: repeat, + repeatIteration: null, + repeatRowId: null, + showTitle: + if showTitle != null then + showTitle + else + title != 'Dashboard Row', + title: title, + type: 'row', + titleSize: titleSize, + addPanels(panels):: self { + panels+: panels, + }, + addPanel(panel, gridPos={}):: self { + panels+: [panel { gridPos: gridPos }], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/singlestat.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/singlestat.libsonnet new file mode 100644 index 0000000..78428d2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/singlestat.libsonnet @@ -0,0 +1,181 @@ +{ + /** + * Creates a singlestat panel. + * + * @name singlestat.new + * + * @param title The title of the singlestat panel. + * @param format (default `'none'`) Unit + * @param description (default `''`) + * @param interval (optional) + * @param height (optional) + * @param datasource (optional) + * @param span (optional) + * @param min_span (optional) + * @param decimals (optional) + * @param valueName (default `'avg'`) + * @param valueFontSize (default `'80%'`) + * @param prefixFontSize (default `'50%'`) + * @param postfixFontSize (default `'50%'`) + * @param mappingType (default `1`) + * @param repeat (optional) + * @param repeatDirection (optional) + * @param prefix (default `''`) + * @param postfix (default `''`) + * @param colors (default `['#299c46','rgba(237, 129, 40, 0.89)','#d44a3a']`) + * @param colorBackground (default `false`) + * @param colorValue (default `false`) + * @param thresholds (default `''`) + * @param valueMaps (default `{value: 'null',op: '=',text: 'N/A'}`) + * @param rangeMaps (default `{value: 'null',op: '=',text: 'N/A'}`) + * @param transparent (optional) + * @param sparklineFillColor (default `'rgba(31, 118, 189, 0.18)'`) + * @param sparklineFull (default `false`) + * @param sparklineLineColor (default `'rgb(31, 120, 193)'`) + * @param sparklineShow (default `false`) + * @param gaugeShow (default `false`) + * @param gaugeMinValue (default `0`) + * @param gaugeMaxValue (default `100`) + * @param gaugeThresholdMarkers (default `true`) + * @param gaugeThresholdLabels (default `false`) + * @param timeFrom (optional) + * @param links (optional) + * @param tableColumn (default `''`) + * @param maxPerRow (optional) + * @param maxDataPoints (default `100`) + * + * @method addTarget(target) Adds a target object. + */ + new( + title, + format='none', + description='', + interval=null, + height=null, + datasource=null, + span=null, + min_span=null, + decimals=null, + valueName='avg', + valueFontSize='80%', + prefixFontSize='50%', + postfixFontSize='50%', + mappingType=1, + repeat=null, + repeatDirection=null, + prefix='', + postfix='', + colors=[ + '#299c46', + 'rgba(237, 129, 40, 0.89)', + '#d44a3a', + ], + colorBackground=false, + colorValue=false, + thresholds='', + valueMaps=[ + { + value: 'null', + op: '=', + text: 'N/A', + }, + ], + rangeMaps=[ + { + from: 'null', + to: 'null', + text: 'N/A', + }, + ], + transparent=null, + sparklineFillColor='rgba(31, 118, 189, 0.18)', + sparklineFull=false, + sparklineLineColor='rgb(31, 120, 193)', + sparklineShow=false, + gaugeShow=false, + gaugeMinValue=0, + gaugeMaxValue=100, + gaugeThresholdMarkers=true, + gaugeThresholdLabels=false, + timeFrom=null, + links=[], + tableColumn='', + maxPerRow=null, + maxDataPoints=100, + ):: + { + [if height != null then 'height']: height, + [if description != '' then 'description']: description, + [if repeat != null then 'repeat']: repeat, + [if repeatDirection != null then 'repeatDirection']: repeatDirection, + [if transparent != null then 'transparent']: transparent, + [if min_span != null then 'minSpan']: min_span, + title: title, + [if span != null then 'span']: span, + type: 'singlestat', + datasource: datasource, + targets: [ + ], + links: links, + [if decimals != null then 'decimals']: decimals, + maxDataPoints: maxDataPoints, + interval: interval, + cacheTimeout: null, + format: format, + prefix: prefix, + postfix: postfix, + nullText: null, + valueMaps: valueMaps, + [if maxPerRow != null then 'maxPerRow']: maxPerRow, + mappingTypes: [ + { + name: 'value to text', + value: 1, + }, + { + name: 'range to text', + value: 2, + }, + ], + rangeMaps: rangeMaps, + mappingType: + if mappingType == 'value' + then + 1 + else if mappingType == 'range' + then + 2 + else + mappingType, + nullPointMode: 'connected', + valueName: valueName, + prefixFontSize: prefixFontSize, + valueFontSize: valueFontSize, + postfixFontSize: postfixFontSize, + thresholds: thresholds, + [if timeFrom != null then 'timeFrom']: timeFrom, + colorBackground: colorBackground, + colorValue: colorValue, + colors: colors, + gauge: { + show: gaugeShow, + minValue: gaugeMinValue, + maxValue: gaugeMaxValue, + thresholdMarkers: gaugeThresholdMarkers, + thresholdLabels: gaugeThresholdLabels, + }, + sparkline: { + fillColor: sparklineFillColor, + full: sparklineFull, + lineColor: sparklineLineColor, + show: sparklineShow, + }, + tableColumn: tableColumn, + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/sql.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/sql.libsonnet new file mode 100644 index 0000000..ab48543 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/sql.libsonnet @@ -0,0 +1,23 @@ +{ + /** + * Creates an SQL target. + * + * @name sql.target + * + * @param rawSql The SQL query + * @param datasource (optional) + * @param format (default `'time_series'`) + * @param alias (optional) + */ + target( + rawSql, + datasource=null, + format='time_series', + alias=null, + ):: { + [if datasource != null then 'datasource']: datasource, + format: format, + [if alias != null then 'alias']: alias, + rawSql: rawSql, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/stat_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/stat_panel.libsonnet new file mode 100644 index 0000000..5d1e5e7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/stat_panel.libsonnet @@ -0,0 +1,222 @@ +{ + /** + * Creates a [stat panel](https://grafana.com/docs/grafana/latest/panels/visualizations/stat-panel/). + * + * @name statPanel.new + * + * @param title Panel title. + * @param description (optional) Panel description. + * @param transparent (default `false`) Whether to display the panel without a background. + * @param datasource (optional) Panel datasource. + * @param allValues (default `false`) Show all values instead of reducing to one. + * @param valueLimit (optional) Limit of values in all values mode. + * @param reducerFunction (default `'mean'`) Function to use to reduce values to when using single value. + * @param fields (default `''`) Fields that should be included in the panel. + * @param orientation (default `'auto'`) Stacking direction in case of multiple series or fields. + * @param colorMode (default `'value'`) 'value' or 'background'. + * @param graphMode (default `'area'`) 'none' or 'area' to enable sparkline mode. + * @param textMode (default `'auto'`) Control if name and value is displayed or just name. + * @param justifyMode (default `'auto'`) 'auto' or 'center'. + * @param unit (default `'none'`) Panel unit field option. + * @param min (optional) Leave empty to calculate based on all values. + * @param max (optional) Leave empty to calculate based on all values. + * @param decimals (optional) Number of decimal places to show. + * @param displayName (optional) Change the field or series name. + * @param noValue (optional) What to show when there is no value. + * @param thresholdsMode (default `'absolute'`) 'absolute' or 'percentage'. + * @param timeFrom (optional) Override the relative time range. + * @param repeat (optional) Name of variable that should be used to repeat this panel. + * @param repeatDirection (default `'h'`) 'h' for horizontal or 'v' for vertical. + * @param maxPerRow (optional) Maximum panels per row in repeat mode. + * @param pluginVersion (default `'7'`) Plugin version the panel should be modeled for. This has been tested with the default, '7', and '6.7'. + * + * @method addTarget(target) Adds a target object. + * @method addTargets(targets) Adds an array of targets. + * @method addLink(link) Adds a [panel link](https://grafana.com/docs/grafana/latest/linking/panel-links/). Argument format: `{ title: 'Link Title', url: 'https://...', targetBlank: true }`. + * @method addLinks(links) Adds an array of links. + * @method addThreshold(step) Adds a [threshold](https://grafana.com/docs/grafana/latest/panels/thresholds/) step. Argument format: `{ color: 'green', value: 0 }`. + * @method addThresholds(steps) Adds an array of threshold steps. + * @method addMapping(mapping) Adds a value mapping. + * @method addMappings(mappings) Adds an array of value mappings. + * @method addDataLink(link) Adds a data link. + * @method addDataLinks(links) Adds an array of data links. + */ + new( + title, + description=null, + transparent=false, + datasource=null, + allValues=false, + valueLimit=null, + reducerFunction='mean', + fields='', + orientation='auto', + colorMode='value', + graphMode='area', + textMode='auto', + justifyMode='auto', + unit='none', + min=null, + max=null, + decimals=null, + displayName=null, + noValue=null, + thresholdsMode='absolute', + timeFrom=null, + repeat=null, + repeatDirection='h', + maxPerRow=null, + pluginVersion='7', + ):: { + + type: 'stat', + title: title, + [if description != null then 'description']: description, + transparent: transparent, + datasource: datasource, + targets: [], + links: [], + [if repeat != null then 'repeat']: repeat, + [if repeat != null then 'repeatDirection']: repeatDirection, + [if timeFrom != null then 'timeFrom']: timeFrom, + [if repeat != null then 'maxPerRow']: maxPerRow, + + // targets + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + + // links + addLink(link):: self { + links+: [link], + }, + addLinks(links):: std.foldl(function(p, l) p.addLink(l), links, self), + + pluginVersion: pluginVersion, + } + ( + + if pluginVersion >= '7' then { + options: { + reduceOptions: { + values: allValues, + [if allValues && valueLimit != null then 'limit']: valueLimit, + calcs: [ + reducerFunction, + ], + fields: fields, + }, + orientation: orientation, + colorMode: colorMode, + graphMode: graphMode, + justifyMode: justifyMode, + textMode: textMode, + }, + fieldConfig: { + defaults: { + unit: unit, + [if min != null then 'min']: min, + [if max != null then 'max']: max, + [if decimals != null then 'decimals']: decimals, + [if displayName != null then 'displayName']: displayName, + [if noValue != null then 'noValue']: noValue, + thresholds: { + mode: thresholdsMode, + steps: [], + }, + mappings: [], + links: [], + }, + }, + + // thresholds + addThreshold(step):: self { + fieldConfig+: { defaults+: { thresholds+: { steps+: [step] } } }, + }, + + // mappings + _nextMapping:: 0, + addMapping(mapping):: self { + local nextMapping = super._nextMapping, + _nextMapping: nextMapping + 1, + fieldConfig+: { defaults+: { mappings+: [mapping { id: nextMapping }] } }, + }, + + // data links + addDataLink(link):: self { + fieldConfig+: { defaults+: { links+: [link] } }, + }, + + // Overrides + addOverride( + matcher=null, + properties=null, + ):: self { + fieldConfig+: { + overrides+: [ + { + [if matcher != null then 'matcher']: matcher, + [if properties != null then 'properties']: properties, + }, + ], + }, + }, + addOverrides(overrides):: std.foldl(function(p, o) p.addOverride(o.matcher, o.properties), overrides, self), + } else { + options: { + fieldOptions: { + values: allValues, + [if allValues && valueLimit != null then 'limit']: valueLimit, + calcs: [ + reducerFunction, + ], + fields: fields, + defaults: { + unit: unit, + [if min != null then 'min']: min, + [if max != null then 'max']: max, + [if decimals != null then 'decimals']: decimals, + [if displayName != null then 'displayName']: displayName, + [if noValue != null then 'noValue']: noValue, + thresholds: { + mode: thresholdsMode, + steps: [], + }, + mappings: [], + links: [], + }, + }, + orientation: orientation, + colorMode: colorMode, + graphMode: graphMode, + justifyMode: justifyMode, + }, + + // thresholds + addThreshold(step):: self { + options+: { fieldOptions+: { defaults+: { thresholds+: { steps+: [step] } } } }, + }, + + // mappings + _nextMapping:: 0, + addMapping(mapping):: self { + local nextMapping = super._nextMapping, + _nextMapping: nextMapping + 1, + options+: { fieldOptions+: { defaults+: { mappings+: [mapping { id: nextMapping }] } } }, + }, + + // data links + addDataLink(link):: self { + options+: { fieldOptions+: { defaults+: { links+: [link] } } }, + }, + } + + ) + { + addThresholds(steps):: std.foldl(function(p, s) p.addThreshold(s), steps, self), + addMappings(mappings):: std.foldl(function(p, m) p.addMapping(m), mappings, self), + addDataLinks(links):: std.foldl(function(p, l) p.addDataLink(l), links, self), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/table_panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/table_panel.libsonnet new file mode 100644 index 0000000..4c686b3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/table_panel.libsonnet @@ -0,0 +1,91 @@ +{ + /** + * Creates a [table panel](https://grafana.com/docs/grafana/latest/panels/visualizations/table-panel/) that can be added in a row. + * It requires the table panel plugin in grafana, which is built-in. + * + * @name table.new + * + * @param title The title of the graph panel. + * @param description (optional) Description of the panel + * @param span (optional) Width of the panel + * @param height (optional) Height of the panel + * @param datasource (optional) Datasource + * @param min_span (optional) Min span + * @param styles (optional) Array of styles for the panel + * @param columns (optional) Array of columns for the panel + * @param sort (optional) Sorting instruction for the panel + * @param transform (optional) Allow table manipulation to present data as desired + * @param transparent (default: 'false') Whether to display the panel without a background + * @param links (optional) Array of links for the panel. + * @return A json that represents a table panel + * + * @method addTarget(target) Adds a target object + * @method addTargets(targets) Adds an array of targets + * @method addColumn(field, style) Adds a column + * @method hideColumn(field) Hides a column + * @method addLink(link) Adds a link + * @method addTransformation(transformation) Adds a transformation object + * @method addTransformations(transformations) Adds an array of transformations + */ + new( + title, + description=null, + span=null, + min_span=null, + height=null, + datasource=null, + styles=[], + transform=null, + transparent=false, + columns=[], + sort=null, + time_from=null, + time_shift=null, + links=[], + ):: { + type: 'table', + title: title, + [if span != null then 'span']: span, + [if min_span != null then 'minSpan']: min_span, + [if height != null then 'height']: height, + datasource: datasource, + targets: [ + ], + styles: styles, + columns: columns, + timeFrom: time_from, + timeShift: time_shift, + links: links, + [if sort != null then 'sort']: sort, + [if description != null then 'description']: description, + [if transform != null then 'transform']: transform, + [if transparent == true then 'transparent']: transparent, + _nextTarget:: 0, + addTarget(target):: self { + local nextTarget = super._nextTarget, + _nextTarget: nextTarget + 1, + targets+: [target { refId: std.char(std.codepoint('A') + nextTarget) }], + }, + addTargets(targets):: std.foldl(function(p, t) p.addTarget(t), targets, self), + addColumn(field, style):: self { + local style_ = style { pattern: field }, + local column_ = { text: field, value: field }, + styles+: [style_], + columns+: [column_], + }, + hideColumn(field):: self { + styles+: [{ + alias: field, + pattern: field, + type: 'hidden', + }], + }, + addLink(link):: self { + links+: [link], + }, + addTransformation(transformation):: self { + transformations+: [transformation], + }, + addTransformations(transformations):: std.foldl(function(p, t) p.addTransformation(t), transformations, self), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/template.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/template.libsonnet new file mode 100644 index 0000000..be253e1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/template.libsonnet @@ -0,0 +1,289 @@ +{ + /** + * Creates a [template](https://grafana.com/docs/grafana/latest/variables/#templates) that can be added to a dashboard. + * + * @name template.new + * + * @param name Name of variable. + * @param datasource Template [datasource](https://grafana.com/docs/grafana/latest/variables/variable-types/add-data-source-variable/) + * @param query [Query expression](https://grafana.com/docs/grafana/latest/variables/variable-types/add-query-variable/) for the datasource. + * @param label (optional) Display name of the variable dropdown. If null, then the dropdown label will be the variable name. + * @param allValues (optional) Formatting for [multi-value variables](https://grafana.com/docs/grafana/latest/variables/formatting-multi-value-variables/#formatting-multi-value-variables) + * @param tagValuesQuery (default `''`) Group values into [selectable tags](https://grafana.com/docs/grafana/latest/variables/variable-value-tags/) + * @param current (default `null`) Can be `null`, `'all'` for all, or any other custom text value. + * @param hide (default `''`) `''`: the variable dropdown displays the variable Name or Label value. `'label'`: the variable dropdown only displays the selected variable value and a down arrow. Any other value: no variable dropdown is displayed on the dashboard. + * @param regex (default `''`) Regex expression to filter or capture specific parts of the names returned by your data source query. To see examples, refer to [Filter variables with regex](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex/). + * @param refresh (default `'never'`) `'never'`: variables queries are cached and values are not updated. This is fine if the values never change, but problematic if they are dynamic and change a lot. `'load'`: Queries the data source every time the dashboard loads. This slows down dashboard loading, because the variable query needs to be completed before dashboard can be initialized. `'time'`: Queries the data source when the dashboard time range changes. Only use this option if your variable options query contains a time range filter or is dependent on the dashboard time range. + * @param includeAll (default `false`) Whether all value option is available or not. + * @param multi (default `false`) Whether multiple values can be selected or not from variable value list. + * @param sort (default `0`) `0`: Without Sort, `1`: Alphabetical (asc), `2`: Alphabetical (desc), `3`: Numerical (asc), `4`: Numerical (desc). + * + * @return A [template](https://grafana.com/docs/grafana/latest/variables/#templates) + */ + new( + name, + datasource, + query, + label=null, + allValues=null, + tagValuesQuery='', + current=null, + hide='', + regex='', + refresh='never', + includeAll=false, + multi=false, + sort=0, + ):: + { + allValue: allValues, + current: $.current(current), + datasource: datasource, + includeAll: includeAll, + hide: $.hide(hide), + label: label, + multi: multi, + name: name, + options: [], + query: query, + refresh: $.refresh(refresh), + regex: regex, + sort: sort, + tagValuesQuery: tagValuesQuery, + tags: [], + tagsQuery: '', + type: 'query', + useTags: false, + }, + /** + * Use an [interval variable](https://grafana.com/docs/grafana/latest/variables/variable-types/add-interval-variable/) to represent time spans such as '1m', '1h', '1d'. You can think of them as a dashboard-wide "group by time" command. Interval variables change how the data is grouped in the visualization. You can also use the Auto Option to return a set number of data points per time span. + * You can use an interval variable as a parameter to group by time (for InfluxDB), date histogram interval (for Elasticsearch), or as a summarize function parameter (for Graphite). + * + * @name template.interval + * + * @param name Variable name + * @param query Comma separated values without spacing of intervals available for selection. Add `'auto'` in the query to turn on the Auto Option. Ex: `'auto,5m,10m,20m'`. + * @param current Currently selected interval. Must be one of the values in the query. `'auto'` is allowed if defined in the query. + * @param hide (default `''`) `''`: the variable dropdown displays the variable Name or Label value. `'label'`: the variable dropdown only displays the selected variable value and a down arrow. Any other value: no variable dropdown is displayed on the dashboard. + * @param label (optional) Display name of the variable dropdown. If null, then the dropdown label will be the variable name. + * @param auto_count (default `300`) Valid only if `'auto'` is defined in query. Number of times the current time range will be divided to calculate the value, similar to the Max data points query option. For example, if the current visible time range is 30 minutes, then the auto interval groups the data into 30 one-minute increments. The default value is 30 steps. + * @param auto_min (default `'10s'`) Valid only if `'auto'` is defined in query. The minimum threshold below which the step count intervals will not divide the time. To continue the 30 minute example, if the minimum interval is set to `'2m'`, then Grafana would group the data into 15 two-minute increments. + * + * @return A new interval variable for templating. + */ + interval( + name, + query, + current, + hide='', + label=null, + auto_count=300, + auto_min='10s', + ):: + { + current: $.current(current), + hide: $.hide(hide), + label: label, + name: name, + query: std.join(',', std.filter($.filterAuto, std.split(query, ','))), + refresh: 2, + type: 'interval', + auto: std.count(std.split(query, ','), 'auto') > 0, + auto_count: auto_count, + auto_min: auto_min, + }, + hide(hide):: + if hide == '' then 0 else if hide == 'label' then 1 else 2, + current(current):: { + [if current != null then 'text']: current, + [if current != null then 'value']: if current == 'auto' then + '$__auto_interval' + else if current == 'all' then + '$__all' + else + current, + }, + /** + * Data [source variables](https://grafana.com/docs/grafana/latest/variables/variable-types/add-data-source-variable/) + * allow you to quickly change the data source for an entire dashboard. + * They are useful if you have multiple instances of a data source, perhaps in different environments. + * + * @name template.datasource + * + * @param name Data source variable name. Ex: `'PROMETHEUS_DS'`. + * @param query Type of data source. Ex: `'prometheus'`. + * @param current Ex: `'Prometheus'`. + * @param hide (default `''`) `''`: the variable dropdown displays the variable Name or Label value. `'label'`: the variable dropdown only displays the selected variable value and a down arrow. Any other value: no variable dropdown is displayed on the dashboard. + * @param label (optional) Display name of the variable dropdown. If null, then the dropdown label will be the variable name. + * @param regex (default `''`) Regex filter for which data source instances to choose from in the variable value drop-down list. Leave this field empty to display all instances. + * @param refresh (default `'load'`) `'never'`: Variables queries are cached and values are not updated. This is fine if the values never change, but problematic if they are dynamic and change a lot. `'load'`: Queries the data source every time the dashboard loads. This slows down dashboard loading, because the variable query needs to be completed before dashboard can be initialized. `'time'`: Queries the data source when the dashboard time range changes. Only use this option if your variable options query contains a time range filter or is dependent on the dashboard time range. + * + * @return A [data source variable](https://grafana.com/docs/grafana/latest/variables/variable-types/add-data-source-variable/). + */ + datasource( + name, + query, + current, + hide='', + label=null, + regex='', + refresh='load', + ):: { + current: $.current(current), + hide: $.hide(hide), + label: label, + name: name, + options: [], + query: query, + refresh: $.refresh(refresh), + regex: regex, + type: 'datasource', + }, + refresh(refresh):: if refresh == 'never' + then + 0 + else if refresh == 'load' + then + 1 + else if refresh == 'time' + then + 2 + else + refresh, + filterAuto(str):: str != 'auto', + /** + * Use a [custom variable](https://grafana.com/docs/grafana/latest/variables/variable-types/add-custom-variable/) + * for values that do not change. + * + * @name template.custom + * This might be numbers, strings, or even other variables. + * @param name Variable name + * @param query Comma separated without spacing list of selectable values. + * @param current Selected value + * @param refresh (default `'never'`) `'never'`: Variables queries are cached and values are not updated. This is fine if the values never change, but problematic if they are dynamic and change a lot. `'load'`: Queries the data source every time the dashboard loads. This slows down dashboard loading, because the variable query needs to be completed before dashboard can be initialized. `'time'`: Queries the data source when the dashboard time range changes. Only use this option if your variable options query contains a time range filter or is dependent on the dashboard time range. + * @param label (default `''`) Display name of the variable dropdown. If you don’t enter a display name, then the dropdown label will be the variable name. + * @param valuelabels (default `{}`) Display names for values defined in query. For example, if `query='new,old'`, then you may display them as follows `valuelabels={new: 'nouveau', old: 'ancien'}`. + * @param multi (default `false`) Whether multiple values can be selected or not from variable value list. + * @param allValues (optional) Formatting for [multi-value variables](https://grafana.com/docs/grafana/latest/variables/formatting-multi-value-variables/#formatting-multi-value-variables) + * @param includeAll (default `false`) Whether all value option is available or not. + * @param hide (default `''`) `''`: the variable dropdown displays the variable Name or Label value. `'label'`: the variable dropdown only displays the selected variable value and a down arrow. Any other value: no variable dropdown is displayed on the dashboard. + * + * @return A custom variable. + */ + custom( + name, + query, + current, + refresh='never', + label='', + valuelabels={}, + multi=false, + allValues=null, + includeAll=false, + hide='', + ):: + { + // self has dynamic scope, so self may not be myself below. + // '$' can't be used neither as this object is not top-level object. + local custom = self, + + allValue: allValues, + current: { + // Both 'all' and 'All' are accepted for consistency. + value: if includeAll && (current == 'All' || current == 'all') then + if multi then ['$__all'] else '$__all' + else + current, + text: if std.isArray(current) then + std.join(' + ', std.map(custom.valuelabel, current)) + else + custom.valuelabel(current), + [if multi then 'selected']: true, + }, + options: std.map(self.option, self.query_array(query)), + hide: $.hide(hide), + includeAll: includeAll, + label: label, + refresh: $.refresh(refresh), + multi: multi, + name: name, + query: query, + type: 'custom', + + valuelabel(value):: if value in valuelabels then + valuelabels[value] + else value, + + option(option):: { + text: custom.valuelabel(option), + value: if includeAll && option == 'All' then '$__all' else option, + [if multi then 'selected']: if multi && std.isArray(current) then + std.member(current, option) + else if multi then + current == option + else + null, + }, + query_array(query):: std.split( + if includeAll then 'All,' + query else query, ',' + ), + }, + /** + * [Text box variables](https://grafana.com/docs/grafana/latest/variables/variable-types/add-text-box-variable/) + * display a free text input field with an optional default value. + * This is the most flexible variable, because you can enter any value. + * Use this type of variable if you have metrics with high cardinality or if you want to + * update multiple panels in a dashboard at the same time. + * + * @name template.text + * + * @param name Variable name. + * @param label (default `''`) Display name of the variable dropdown. If you don’t enter a display name, then the dropdown label will be the variable name. + * + * @return A text box variable. + */ + text( + name, + label='' + ):: + { + current: { + selected: false, + text: '', + value: '', + }, + name: name, + label: label, + query: '', + type: 'textbox', + }, + /** + * [Ad hoc filters](https://grafana.com/docs/grafana/latest/variables/variable-types/add-ad-hoc-filters/) + * allow you to add key/value filters that are automatically added to all metric queries + * that use the specified data source. Unlike other variables, you do not use ad hoc filters in queries. + * Instead, you use ad hoc filters to write filters for existing queries. + * Note: Ad hoc filter variables only work with InfluxDB, Prometheus, and Elasticsearch data sources. + * + * @name template.adhoc + * + * @param name Variable name. + * @param datasource Target data source + * @param label (optional) Display name of the variable dropdown. If you don’t enter a display name, then the dropdown label will be the variable name. + * @param hide (default `''`) `''`: the variable dropdown displays the variable Name or Label value. `'label'`: the variable dropdown only displays the selected variable value and a down arrow. Any other value: no variable dropdown is displayed on the dashboard. + * + * @return An ad hoc filter + */ + adhoc( + name, + datasource, + label=null, + hide='', + ):: + { + datasource: datasource, + hide: $.hide(hide), + label: label, + name: name, + type: 'adhoc', + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/text.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/text.libsonnet new file mode 100644 index 0000000..18020a6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/text.libsonnet @@ -0,0 +1,43 @@ +{ + /** + * Creates a [text panel](https://grafana.com/docs/grafana/latest/panels/visualizations/text-panel/). + * + * @name text.new + * + * @param title (default `''`) Panel title. + * @param description (optional) Panel description. + * @param datasource (optional) Panel datasource. + * @param span (optional) + * @param content (default `''`) + * @param mode (default `'markdown'`) Rendering of the content: 'markdown','html', ... + * @param transparent (optional) Whether to display the panel without a background. + * @param repeat (optional) Name of variable that should be used to repeat this panel. + * @param repeatDirection (default `'h'`) 'h' for horizontal or 'v' for vertical. + * @param repeatMaxPerRow (optional) Maximum panels per row in repeat mode. + */ + new( + title='', + span=null, + mode='markdown', + content='', + transparent=null, + description=null, + datasource=null, + repeat=null, + repeatDirection=null, + repeatMaxPerRow=null, + ):: + { + [if transparent != null then 'transparent']: transparent, + title: title, + [if span != null then 'span']: span, + type: 'text', + mode: mode, + content: content, + [if description != null then 'description']: description, + datasource: datasource, + [if repeat != null then 'repeat']: repeat, + [if repeat != null then 'repeatDirection']: repeatDirection, + [if repeat != null then 'maxPerRow']: repeatMaxPerRow, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/timepicker.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/timepicker.libsonnet new file mode 100644 index 0000000..9c18bef --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/timepicker.libsonnet @@ -0,0 +1,40 @@ +{ + /** + * Creates a Timepicker + * + * @name timepicker.new + * + * @param refresh_intervals (default: `['5s','10s','30s','1m','5m','15m','30m','1h','2h','1d']`) Array of time durations + * @param time_options (default: `['5m','15m','1h','6h','12h','24h','2d','7d','30d']`) Array of time durations + */ + new( + refresh_intervals=[ + '5s', + '10s', + '30s', + '1m', + '5m', + '15m', + '30m', + '1h', + '2h', + '1d', + ], + time_options=[ + '5m', + '15m', + '1h', + '6h', + '12h', + '24h', + '2d', + '7d', + '30d', + ], + nowDelay=null, + ):: { + refresh_intervals: refresh_intervals, + time_options: time_options, + [if nowDelay != null then 'nowDelay']: nowDelay, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/transformation.libsonnet b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/transformation.libsonnet new file mode 100644 index 0000000..5e62ade --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet-lib/grafonnet/transformation.libsonnet @@ -0,0 +1,12 @@ +{ + /** + * @name transformation.new + */ + new( + id='', + options={} + ):: { + id: id, + options: options, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json new file mode 100644 index 0000000..cb19173 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/jsonnetfile.json @@ -0,0 +1,15 @@ +{ + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-v11.4.0" + } + }, + "version": "main" + } + ], + "legacyImports": false, + "version": 1 +} \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet new file mode 100644 index 0000000..e6a2060 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet @@ -0,0 +1 @@ +import 'github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet' diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/accesspolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/accesspolicy.libsonnet new file mode 100644 index 0000000..3a7dd8e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/accesspolicy.libsonnet @@ -0,0 +1,90 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.accesspolicy', name: 'accesspolicy' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Role', 'BuiltinRole', 'Team', 'User'], name: 'value', type: ['string'] }], help: 'Policies can apply to roles, teams, or users\nApplying policies to individual users is supported, but discouraged' } }, + withKind(value): { + role+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + '#withXname': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withXname(value): { + role+: { + xname: value, + }, + }, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withKind': { 'function': { args: [{ default: '*', enums: null, name: 'value', type: ['string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKind(value='*'): { + kind: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific sub-elements like "alert.rules" or "dashboard.permissions"????' } }, + withTarget(value): { + target: value, + }, + '#withVerb': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerb(value): { + verb: value, + }, + '#withVerbMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerbMixin(value): { + verb+: value, + }, + }, + '#withScope': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScope(value): { + scope: value, + }, + '#withScopeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withScopeMixin(value): { + scope+: value, + }, + scope+: + { + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + scope+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + scope+: { + name: value, + }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/alerting.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/alerting.libsonnet new file mode 100644 index 0000000..c5e1415 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/alerting.libsonnet @@ -0,0 +1,9 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting', name: 'alerting' }, + contactPoint: import 'clean/alerting/contactPoint.libsonnet', + notificationPolicy: import 'clean/alerting/notificationPolicy.libsonnet', + muteTiming: import 'clean/alerting/muteTiming.libsonnet', + ruleGroup: import 'clean/alerting/ruleGroup.libsonnet', + notificationTemplate: import 'clean/alerting/notificationTemplate.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..3f601b3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/contactPoint.libsonnet @@ -0,0 +1,33 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#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.' } }, + withDisableResolveMessage(value=true): { + disableResolveMessage: value, + }, + '#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.' } }, + withName(value): { + name: value, + }, + '#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.' } }, + withProvenance(value): { + provenance: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#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.' } }, + withType(value): { + type: value, + }, + '#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.' } }, + withUid(value): { + uid: value, + }, +} ++ (import '../../custom/alerting/contactPoint.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..a36d339 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/muteTiming.libsonnet @@ -0,0 +1,135 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + interval+: + { + '#': { help: '', name: 'interval' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { + days_of_month: + (if std.isArray(value) + then value + else [value]), + }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { + days_of_month+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { + months: + (if std.isArray(value) + then value + else [value]), + }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { + months+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { + times: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { + times+: + (if std.isArray(value) + then value + else [value]), + }, + times+: + { + '#': { help: '', name: 'times' }, + '#withEndTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withEndTime(value): { + end_time: value, + }, + '#withStartTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStartTime(value): { + start_time: value, + }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { + weekdays: + (if std.isArray(value) + then value + else [value]), + }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { + weekdays+: + (if std.isArray(value) + then value + else [value]), + }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { + years: + (if std.isArray(value) + then value + else [value]), + }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { + years+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ (import '../../custom/alerting/muteTiming.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..618b6a9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationPolicy.libsonnet @@ -0,0 +1,97 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withContinue(value=true): { + continue: value, + }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withGroupInterval(value): { + group_interval: value, + }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withGroupWait(value): { + group_wait: value, + }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withRepeatInterval(value): { + repeat_interval: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withGroupBy(value): { + group_by: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withGroupByMixin(value): { + group_by+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { + matchers: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { + matchers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withMuteTimeIntervals(value): { + mute_time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withMuteTimeIntervalsMixin(value): { + mute_time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withReceiver(value): { + receiver: value, + }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withRoutes(value): { + routes: + (if std.isArray(value) + then value + else [value]), + }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'A Route is a node that contains definitions of how to handle alerts. This is modified\nfrom the upstream alertmanager in that it adds the ObjectMatchers property.' } }, + withRoutesMixin(value): { + routes+: + (if std.isArray(value) + then value + else [value]), + }, + matcher+: + { + '#': { help: '', name: 'matcher' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + Name: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + Type: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { + Value: value, + }, + }, +} ++ (import '../../custom/alerting/notificationPolicy.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationTemplate.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationTemplate.libsonnet new file mode 100644 index 0000000..fe210e8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/notificationTemplate.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationTemplate', name: 'notificationTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { + template: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..f844a0a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/clean/alerting/ruleGroup.libsonnet @@ -0,0 +1,147 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withInterval(value): { + interval: value, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + rule+: + { + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { + annotations: value, + }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { + annotations+: value, + }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { + condition: value, + }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { + data: + (if std.isArray(value) + then value + else [value]), + }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { + data+: + (if std.isArray(value) + then value + else [value]), + }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { + execErrState: value, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + folderUID: value, + }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing.\nBefore this time has elapsed, the rule is only considered to be Pending.' } }, + withFor(value): { + 'for': value, + }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { + isPaused: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { + labels+: value, + }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { + noDataState: value, + }, + '#withOrgID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOrgID(value): { + orgID: value, + }, + '#withRuleGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRuleGroup(value): { + ruleGroup: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasourceUid(value): { + datasourceUid: value, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withModelMixin(value): { + model+: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRefId(value): { + refId: value, + }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { + relativeTimeRange: value, + }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { + relativeTimeRange+: value, + }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withFrom(value): { + relativeTimeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withTo(value): { + relativeTimeRange+: { + to: value, + }, + }, + }, + }, + }, +} ++ (import '../../custom/alerting/ruleGroup.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..4b8bbf0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/contactPoint.libsonnet @@ -0,0 +1,12 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#'+:: { + help+: + ||| + + + **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. + |||, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..4a2efb3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/muteTiming.libsonnet @@ -0,0 +1,8 @@ +{ + '#withTimeIntervals': { ignore: true }, + '#withIntervals': super['#withTimeIntervals'], + withIntervals: super.withTimeIntervals, + '#withTimeIntervalsMixin': { ignore: true }, + '#withIntervalsMixin': super['#withTimeIntervalsMixin'], + withIntervalsMixin: super.withTimeIntervalsMixin, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..cf9a2b7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/notificationPolicy.libsonnet @@ -0,0 +1,12 @@ +{ + '#withReceiver': { ignore: true }, + '#withContactPoint': super['#withReceiver'], + withContactPoint: super.withReceiver, + + '#withRoutes': { ignore: true }, + '#withPolicy': super['#withRoutes'], + withPolicy: super.withRoutes, + '#withRoutesMixin': { ignore: true }, + '#withPolicyMixin': super['#withRoutesMixin'], + withPolicyMixin: super.withRoutesMixin, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..4ed32af --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/alerting/ruleGroup.libsonnet @@ -0,0 +1,13 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + rule+: { + '#':: d.package.newSub('rule', ''), + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet new file mode 100644 index 0000000..ea8cb55 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard.libsonnet @@ -0,0 +1,69 @@ +local util = import './util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new dashboard with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withSchemaVersion() + + self.withTimezone('utc') + + self.time.withFrom('now-6h') + + self.time.withTo('now'), + + '#withSchemaVersion': { 'function'+: { args: [d.arg('value', d.T.integer, default=39)] } }, + withSchemaVersion(value=39): { + schemaVersion: value, + }, + + '#withPanels':: d.func.new( + '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanels(panels, setPanelIDs=true): { + _panels:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + '#withPanelsMixin':: d.func.new( + '`withPanelsMixin` adds more panels to a dashboard.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanelsMixin(panels, setPanelIDs=true): { + _panels+:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + + graphTooltip+: { + // 0 - Default + // 1 - Shared crosshair + // 2 - Shared tooltip + '#withSharedCrosshair':: d.func.new( + 'Share crosshair on all panels.', + ), + withSharedCrosshair(): + { graphTooltip: 1 }, + + '#withSharedTooltip':: d.func.new( + 'Share crosshair and tooltip on all panels.', + ), + withSharedTooltip(): + { graphTooltip: 2 }, + }, +} ++ (import './dashboard/annotation.libsonnet') ++ (import './dashboard/link.libsonnet') ++ (import './dashboard/variable.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet new file mode 100644 index 0000000..02892ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/annotation.libsonnet @@ -0,0 +1,36 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#annotation':: {}, + + '#withAnnotations': + d.func.new( + ||| + `withAnnotations` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotations(value): super.annotation.withList(value), + + '#withAnnotationsMixin': + d.func.new( + ||| + `withAnnotationsMixin` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotationsMixin(value): super.annotation.withListMixin(value), + + annotation: + super.annotation.list + + { + '#':: d.package.newSub( + 'annotation', + '', + ), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet new file mode 100644 index 0000000..eb9b2fe --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/link.libsonnet @@ -0,0 +1,90 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withLinks':: d.func.new( + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + `withLinks` takes an array of [link objects](./link.md). + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + [d.arg('value', d.T.array)], + ), + '#withLinksMixin':: self['#withLinks'], + + link+: { + '#':: d.package.newSub( + 'link', + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + ), + + dashboards+: { + '#new':: d.func.new( + ||| + Create links to dashboards based on `tags`. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('tags', d.T.array), + ] + ), + new(title, tags): + self.withTitle(title) + + self.withType('dashboards') + + self.withTags(tags), + + '#withTitle':: {}, + '#withType':: {}, + '#withTags':: {}, + }, + + link+: { + '#new':: d.func.new( + ||| + Create link to an arbitrary URL. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('url', d.T.string), + ] + ), + new(title, url): + self.withTitle(title) + + self.withType('link') + + self.withUrl(url), + + '#withTitle':: {}, + '#withType':: {}, + '#withUrl':: {}, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet new file mode 100644 index 0000000..b4ce4d3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/dashboard/variable.libsonnet @@ -0,0 +1,525 @@ +local util = import '../util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local var = super.variable.list, + + '#withVariables': + d.func.new( + ||| + `withVariables` adds an array of variables to a dashboard + |||, + args=[d.arg('value', d.T.array)] + ), + withVariables(value): super.variable.withList(value), + + '#withVariablesMixin': + d.func.new( + ||| + `withVariablesMixin` adds an array of variables to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withVariablesMixin(value): super.variable.withListMixin(value), + + variable: { + '#':: d.package.newSub( + 'variable', + ||| + Example usage: + + ```jsonnet + local g = import 'g.libsonnet'; + local var = g.dashboard.variable; + + local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + + local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + + g.dashboard.new('my dashboard') + + g.dashboard.withVariables([ + customVar, + queryVar, + ]) + ``` + |||, + ), + + local generalOptions = { + generalOptions+: + { + + '#withName': var['#withName'], + withName: var.withName, + '#withLabel': var['#withLabel'], + withLabel: var.withLabel, + '#withDescription': var['#withDescription'], + withDescription: var.withDescription, + + showOnDashboard: { + '#withLabelAndValue':: d.func.new(''), + withLabelAndValue(): var.withHide(0), + '#withValueOnly':: d.func.new(''), + withValueOnly(): var.withHide(1), + '#withNothing':: d.func.new(''), + withNothing(): var.withHide(2), + }, + + '#withCurrent':: d.func.new( + ||| + `withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + |||, + args=[ + d.arg('key', d.T.any), + d.arg('value', d.T.any, default=''), + ] + ), + withCurrent(key, value=key): { + local multi(v) = + if std.get(self, 'multi', false) + && !std.isArray(v) + then [v] + else v, + current: { + selected: false, + text: multi(key), + value: multi(value), + }, + }, + }, + }, + + local selectionOptions = + { + selectionOptions: + { + '#withMulti':: d.func.new( + 'Enable selecting multiple values.', + args=[ + d.arg('value', d.T.boolean, default=true), + ] + ), + withMulti(value=true): { + multi: value, + }, + + '#withIncludeAll':: d.func.new( + ||| + `withIncludeAll` enables an option to include all variables. + + Optionally you can set a `customAllValue`. + |||, + args=[ + d.arg('value', d.T.boolean, default=true), + d.arg('customAllValue', d.T.string, default=null), + ] + ), + withIncludeAll(value=true, customAllValue=null): { + includeAll: value, + [if customAllValue != null then 'allValue']: customAllValue, + }, + }, + }, + + query: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + Create a query template variable. + + `query` argument is optional, this can also be set with `query.queryTypes`. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('query', d.T.string, default=''), + ] + ), + new(name, query=''): + var.withName(name) + + var.withType('query') + + var.withQuery(query), + + '#withDatasource':: d.func.new( + 'Select a datasource for the variable template query.', + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#withDatasourceFromVariable':: d.func.new( + 'Select the datasource from another template variable.', + args=[ + d.arg('variable', d.T.object), + ] + ), + withDatasourceFromVariable(variable): + if variable.type == 'datasource' + then self.withDatasource(variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + '#withRegex':: d.func.new( + ||| + `withRegex` can extract part of a series name or metric node segment. Named + capture groups can be used to separate the display text and value + ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + + '#withSort':: d.func.new( + ||| + Choose how to sort the values in the dropdown. + + This can be called as `withSort() to use the integer values for each + option. If `i==0` then it will be ignored and the other arguments will take + precedence. + + The numerical values are: + + - 1 - Alphabetical (asc) + - 2 - Alphabetical (desc) + - 3 - Numerical (asc) + - 4 - Numerical (desc) + - 5 - Alphabetical (case-insensitive, asc) + - 6 - Alphabetical (case-insensitive, desc) + |||, + args=[ + d.arg('i', d.T.number, default=0), + d.arg('type', d.T.string, default='alphabetical'), + d.arg('asc', d.T.boolean, default=true), + d.arg('caseInsensitive', d.T.boolean, default=false), + ], + ), + withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): + if i != 0 // provide fallback to numerical value + then { sort: i } + else + { + local mapping = { + alphabetical: + if !caseInsensitive + then + if asc + then 1 + else 2 + else + if asc + then 5 + else 6, + numerical: + if asc + then 3 + else 4, + }, + sort: mapping[type], + }, + + // TODO: Expand with Query types to match GUI + queryTypes: { + '#withLabelValues':: d.func.new( + 'Construct a Prometheus template variable using `label_values()`.', + args=[ + d.arg('label', d.T.string), + d.arg('metric', d.T.string, default=''), + ] + ), + withLabelValues(label, metric=''): + if metric == '' + then var.withQuery('label_values(%s)' % label) + else var.withQuery('label_values(%s, %s)' % [metric, label]), + + '#withQueryResult':: d.func.new( + 'Construct a Prometheus template variable using `query_result()`.', + args=[ + d.arg('query', d.T.string), + ] + ), + withQueryResult(query): + var.withQuery('query_result(%s)' % query), + }, + + // Deliberately undocumented, use `refresh` below + withRefresh(value): { + // 1 - On dashboard load + // 2 - On time range chagne + refresh: value, + }, + + local withRefresh = self.withRefresh, + refresh+: { + '#onLoad':: d.func.new( + 'Refresh label values on dashboard load.' + ), + onLoad(): withRefresh(1), + + '#onTime':: d.func.new( + 'Refresh label values on time range change.' + ), + onTime(): withRefresh(2), + }, + }, + + custom: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + `new` creates a custom template variable. + + The `values` array accepts an object with key/value keys, if it's not an object + then it will be added as a string. + + Example: + ``` + [ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, + ] + |||, + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('custom') + + { + // Make values array available in jsonnet + values:: [ + if !std.isObject(item) + then { + key: std.toString(item), + value: std.toString(item), + } + else item + for item in values + ], + + // Render query from values array + query: + std.join(',', [ + std.join(' : ', [item.key, item.value]) + for item in self.values + ]), + + // Set current/options + current: + util.dashboard.getCurrentFromValues( + self.values, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.values), + }, + + withQuery(query): { + values:: util.dashboard.parseCustomQuery(query), + query: query, + }, + }, + + textbox: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a textbox template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('default', d.T.string, default=''), + ] + ), + new(name, default=''): + var.withName(name) + + var.withType('textbox') + + { + local this = self, + default:: default, + query: self.default, + + // Set current/options + keyvaluedict:: [{ key: this.query, value: this.query }], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + }, + + constant: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a hidden constant template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('value', d.T.string), + ] + ), + new(name, value=''): + var.withName(name) + + var.withType('constant') + + var.withHide(2) + + var.withQuery(value), + }, + + datasource: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + '`new` creates a datasource template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + ] + ), + new(name, type): + var.withName(name) + + var.withType('datasource') + + var.withQuery(type), + + '#withRegex':: d.func.new( + ||| + `withRegex` filter for which data source instances to choose from in the + variable value list. Example: `/^prod/` + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + }, + + interval: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an interval template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('interval') + + { + // Make values array available in jsonnet + values:: values, + // Render query from values array + query: std.join(',', self.values), + + // Set current/options + keyvaluedict:: [ + { + key: item, + value: item, + } + for item in values + ], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + + + '#withAutoOption':: d.func.new( + ||| + `withAutoOption` adds an options to dynamically calculate interval by dividing + time range by the count specified. + + `minInterval' has to be either unit-less or end with one of the following units: + "y, M, w, d, h, m, s, ms". + |||, + args=[ + d.arg('count', d.T.number), + d.arg('minInterval', d.T.string), + ] + ), + withAutoOption(count=30, minInterval='10s'): { + local this = self, + + auto: true, + auto_count: count, + auto_min: minInterval, + + // Add auto item to current/options + keyvaluedict:: + [{ key: 'auto', value: '$__auto_interval_' + this.name }] + + super.keyvaluedict, + }, + }, + + adhoc: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an adhoc template variable for datasource with `type` and `uid`.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + new(name, type, uid): + var.withName(name) + + var.withType('adhoc') + + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#newFromDatasourceVariable':: d.func.new( + 'Same as `new` but selecting the datasource from another template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('variable', d.T.object), + ] + ), + newFromDatasourceVariable(name, variable): + if variable.type == 'datasource' + then self.new(name, variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/panel.libsonnet new file mode 100644 index 0000000..240a044 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/panel.libsonnet @@ -0,0 +1,171 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +// match name/title to reduce diff in docs +local panelNames = { + alertgroups: 'alertGroups', + annolist: 'annotationsList', + barchart: 'barChart', + bargauge: 'barGauge', + dashlist: 'dashboardList', + nodeGraph: 'nodeGraph', + piechart: 'pieChart', + 'state-timeline': 'stateTimeline', + 'status-history': 'statusHistory', + timeseries: 'timeSeries', + xychart: 'xyChart', +}; + +local getPanelName(type) = + std.get(panelNames, type, type); + +{ + '#new':: d.func.new( + 'Creates a new %s panel with a title.' % getPanelName(self.panelOptions.withType().type), + args=[d.arg('title', d.T.string)] + ), + new(title): + self.panelOptions.withTitle(title) + + self.panelOptions.withType() + + self.panelOptions.withPluginVersion() + // Default to Mixed datasource so panels can be datasource agnostic, this + // requires query targets to explicitly set datasource, which is a lot more + // interesting from a reusability standpoint. + + self.queryOptions.withDatasource('datasource', '-- Mixed --'), + + // Backwards compatible entries, ignored in docs + link+: self.panelOptions.link + { '#':: { ignore: true } }, + thresholdStep+: self.standardOptions.threshold.step + { '#':: { ignore: true } }, + transformation+: self.queryOptions.transformation + { '#':: { ignore: true } }, + valueMapping+: self.standardOptions.mapping + { '#':: { ignore: true } }, + fieldOverride+: self.standardOptions.override + { '#':: { ignore: true } }, + + '#gridPos': {}, // use withGridPos instead, a bit more concise. + local gridPos = self.gridPos, + panelOptions+: { + '#withPluginVersion': {}, + + '#withGridPos': d.func.new( + ||| + `withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + + All arguments default to `null`, which means they will remain unchanged or unset. + |||, + args=[ + d.arg('h', d.T.number, default='null'), + d.arg('w', d.T.number, default='null'), + d.arg('x', d.T.number, default='null'), + d.arg('y', d.T.number, default='null'), + ] + ), + withGridPos(h=null, w=null, x=null, y=null): + (if h != null then gridPos.withH(h) else {}) + + (if w != null then gridPos.withW(w) else {}) + + (if x != null then gridPos.withX(x) else {}) + + (if y != null then gridPos.withY(y) else {}), + }, + + '#datasource':: {}, // use withDatasource instead, bit more concise + local datasource = self.datasource, + queryOptions+: { + '#withDatasource':: d.func.new( + ||| + `withDatasource` sets the datasource for all queries in a panel. + + The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + |||, + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + datasource.withType(type) + + datasource.withUid(uid), + }, + + standardOptions+: { + threshold+: { step+: { '#':: d.package.newSub('threshold.step', '') } }, + + local overrides = super.override, + local commonOverrideFunctions = { + '#new':: d.fn( + '`new` creates a new override of type `%s`.' % self.type, + args=[ + d.arg('value', d.T.string), + ] + ), + new(value): + overrides.matcher.withId(self.type) + + overrides.matcher.withOptions(value), + + '#withProperty':: d.fn( + ||| + `withProperty` adds a property that needs to be overridden. This function can + be called multiple time, adding more properties. + |||, + args=[ + d.arg('id', d.T.string), + d.arg('value', d.T.any), + ] + ), + withProperty(id, value): + overrides.withPropertiesMixin([ + overrides.properties.withId(id) + + overrides.properties.withValue(value), + ]), + + '#withPropertiesFromOptions':: d.fn( + ||| + `withPropertiesFromOptions` takes an object with properties that need to be + overridden. See example code above. + |||, + args=[ + d.arg('options', d.T.object), + ] + ), + withPropertiesFromOptions(options): + local infunc(input, path=[]) = + std.foldl( + function(acc, p) + acc + ( + if p == 'custom' + then infunc(input[p], path=path + [p]) + else + overrides.withPropertiesMixin([ + overrides.properties.withId(std.join('.', path + [p])) + + overrides.properties.withValue(input[p]), + ]) + ), + std.objectFields(input), + {} + ); + infunc(options.fieldConfig.defaults), + }, + + override: + { + '#':: d.package.newSub( + 'override', + ||| + Overrides allow you to customize visualization settings for specific fields or + series. This is accomplished by adding an override rule that targets + a particular set of fields and that can each define multiple options. + + ```jsonnet + override.byType.new('number') + + override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') + ) + ``` + ||| + ), + byName: commonOverrideFunctions + { type:: 'byName' }, + byRegexp: commonOverrideFunctions + { type:: 'byRegexp' }, + byType: commonOverrideFunctions + { type:: 'byType' }, + byQuery: commonOverrideFunctions + { type:: 'byFrameRefID' }, + // TODO: byValue takes more complex `options` than string + byValue: commonOverrideFunctions + { type:: 'byValue' }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet new file mode 100644 index 0000000..8926449 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/azureMonitor.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafana-azure-monitor-datasource', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet new file mode 100644 index 0000000..208ee65 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/cloudWatch.libsonnet @@ -0,0 +1,23 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local withDatasourceStub = { + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloudwatch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, + }, + + CloudWatchAnnotationQuery+: withDatasourceStub, + CloudWatchLogsQuery+: withDatasourceStub, + CloudWatchMetricsQuery+: withDatasourceStub, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet new file mode 100644 index 0000000..7d1d54a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/elasticsearch.libsonnet @@ -0,0 +1,20 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, + metrics+: { '#': { help: '', name: 'metrics' } }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'elasticsearch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet new file mode 100644 index 0000000..02417b6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/expr.libsonnet @@ -0,0 +1,12 @@ +{ + '#': { + help: 'Server Side Expression operations for grafonnet.alerting.ruleGroup.rule', + name: 'expr', + }, + TypeMath+: { '#': { help: 'grafonnet.query.expr.TypeMath', name: 'TypeMath' } }, + TypeReduce+: { '#': { help: 'grafonnet.query.expr.TypeReduce', name: 'TypeReduce' } }, + TypeResample+: { '#': { help: 'grafonnet.query.expr.TypeResample', name: 'TypeResample' } }, + TypeClassicConditions+: { '#': { help: 'grafonnet.query.expr.TypeClassicConditions', name: 'TypeClassicConditions' } }, + TypeThreshold+: { '#': { help: 'grafonnet.query.expr.TypeThreshold', name: 'TypeThreshold' } }, + TypeSql+: { '#': { help: 'grafonnet.query.expr.TypeSql', name: 'TypeSql' } }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet new file mode 100644 index 0000000..1adaa99 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloud-monitoring', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet new file mode 100644 index 0000000..2f52821 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/grafanaPyroscope.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafanapyroscope', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet new file mode 100644 index 0000000..4831145 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/loki.libsonnet @@ -0,0 +1,28 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new loki query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'loki', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet new file mode 100644 index 0000000..35c454e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/parca.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'parca', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet new file mode 100644 index 0000000..68e1e05 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/prometheus.libsonnet @@ -0,0 +1,48 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new prometheus query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withIntervalFactor':: d.func.new( + 'Set the interval factor for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withIntervalFactor(value): { + intervalFactor: value, + }, + + '#withLegendFormat':: d.func.new( + 'Set the legend format for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withLegendFormat(value): { + legendFormat: value, + }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'prometheus', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet new file mode 100644 index 0000000..f9fc910 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/tempo.libsonnet @@ -0,0 +1,30 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new tempo query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('query', d.T.string), + d.arg('filters', d.T.array), + ] + ), + new(datasource, query, filters): + self.withDatasource(datasource) + + self.withQuery(query) + + self.withFilters(filters), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'tempo', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet new file mode 100644 index 0000000..b482dbc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/query/testData.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(): { + datasource+: { + type: 'datasource', + uid: 'grafana', + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/row.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/row.libsonnet new file mode 100644 index 0000000..049537e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/row.libsonnet @@ -0,0 +1,26 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new row panel with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withType() + + self.withCollapsed(false) + + self.gridPos.withX(0) + + self.gridPos.withH(1) + + self.gridPos.withW(24), + + '#gridPos':: {}, // use withGridPos instead + '#withGridPos':: d.func.new( + '`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values.', + args=[d.arg('y', d.T.number)] + ), + withGridPos(y): + self.gridPos.withX(0) + + self.gridPos.withY(y) + + self.gridPos.withH(1) + + self.gridPos.withW(24), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet new file mode 100644 index 0000000..da7b2c8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/dashboard.libsonnet @@ -0,0 +1,55 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local root = self, + + '#getOptionsForCustomQuery':: d.func.new( + ||| + `getOptionsForCustomQuery` provides values for the `options` and `current` fields. + These are required for template variables of type 'custom'but do not automatically + get populated by Grafana when importing a dashboard from JSON. + + This is a bit of a hack and should always be called on functions that set `type` on + a template variable. Ideally Grafana populates these fields from the `query` value + but this provides a backwards compatible solution. + |||, + args=[d.arg('query', d.T.string)], + ), + getOptionsForCustomQuery(query, multi): { + local values = root.parseCustomQuery(query), + current: root.getCurrentFromValues(values, multi), + options: root.getOptionsFromValues(values), + }, + + getCurrentFromValues(values, multi): { + selected: false, + text: if multi then [values[0].key] else values[0].key, + value: if multi then [values[0].value] else values[0].value, + }, + + getOptionsFromValues(values): + std.mapWithIndex( + function(i, item) { + selected: i == 0, + text: item.key, + value: item.value, + }, + values + ), + + parseCustomQuery(query): + std.map( + function(v) + // Split items into key:value pairs + local split = std.splitLimit(v, ' : ', 1); + { + key: std.stripChars(split[0], ' '), + value: + if std.length(split) == 2 + then std.stripChars(split[1], ' ') + else self.key, + }, + xtd.string.splitEscape(query, ',') // Split query by comma, unless the comma is escaped + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet new file mode 100644 index 0000000..b4a41b3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/grid.libsonnet @@ -0,0 +1,212 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +local panelUtil = import './panel.libsonnet'; + +{ + local root = self, + + local gridWidth = 24, + + '#makeGrid':: d.func.new( + ||| + `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` + and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, + then all panels below it will be folded into the row. + + This function will use the full grid of 24 columns, setting `panelWidth` to a value + that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) + Other value for `panelWidth` will leave a gap on the far right. + + Optional `startY` can be provided to place generated grid above or below existing panels. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + makeGrid(panels, panelWidth=8, panelHeight=8, startY=0): + local sanitizePanels(ps) = std.map( + function(p) + local sanePanel = panelUtil.sanitizePanel(p); + ( + if p.type == 'row' + then sanePanel + { + panels: sanitizePanels(sanePanel.panels), + } + else sanePanel + { + gridPos+: { + h: panelHeight, + w: panelWidth, + }, + } + ), + ps + ); + + local sanitizedPanels = sanitizePanels(panels); + + local grouped = panelUtil.groupPanelsInRows(sanitizedPanels); + + local panelsBeforeRows = panelUtil.getPanelsBeforeNextRow(grouped); + local rowPanels = + std.filter( + function(p) p.type == 'row', + grouped + ); + + local CalculateXforPanel(index, panel) = + local panelsPerRow = std.floor(gridWidth / panelWidth); + local col = std.mod(index, panelsPerRow); + panel + { gridPos+: { x: panelWidth * col } }; + + local panelsBeforeRowsWithX = std.mapWithIndex(CalculateXforPanel, panelsBeforeRows); + + local rowPanelsWithX = + std.map( + function(row) + row + { panels: std.mapWithIndex(CalculateXforPanel, row.panels) }, + rowPanels + ); + + local uncollapsed = panelUtil.resolveCollapsedFlagOnRows(panelsBeforeRowsWithX + rowPanelsWithX); + + local normalized = panelUtil.normalizeY(uncollapsed); + + std.map(function(p) p + { gridPos+: { y+: startY } }, normalized), + + '#wrapPanels':: d.func.new( + ||| + `wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. + 'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + wrapPanels(panels, panelWidth=8, panelHeight=8, startY=0): + + local calculateGridPosForPanel(acc, panel) = + local gridPos = std.get(panel, 'gridPos', {}); + local width = std.get(gridPos, 'w', panelWidth); + local height = std.get(gridPos, 'h', panelHeight); + if acc.cursor.x + width > gridWidth + then + // start new row as width exceeds gridWidth + { + panels+: [ + panel { + gridPos+: + { + x: 0, + y: acc.cursor.y + height, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: 0 + width, + y: acc.cursor.y + height, + maxH: if height > acc.cursor.maxH then height else acc.cursor.maxH, + }, + } + else + // enough width, place panel on current row + { + panels+: [ + panel { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: acc.cursor.x + width, + y: acc.cursor.y, + maxH: if height > acc.cursor.maxH then height else acc.cursor.maxH, + }, + }; + + std.foldl( + function(acc, panel) + if panel.type == 'row' + then + ( + if std.objectHas(panel, 'panels') && std.length(panel.panels) > 0 + then + local rowPanels = + std.foldl( + function(acc, panel) + acc + calculateGridPosForPanel(acc, panel), + panel.panels, + { + panels+: [], + // initial + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + }, + ); + acc { + panels+: [ + panel { + //rows panels + panels: rowPanels.panels, + gridPos+: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + }, + + }, + ], + cursor:: rowPanels.cursor, + } + else + acc { + panels+: [ + panel { + panels: [], + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + h: 1, + }, + }, + ], + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + } + ) + else + // handle regular panel + acc + calculateGridPosForPanel(acc, panel), + panels, + // Initial value for acc: + { + panels: [], + cursor:: { + x: 0, + y: startY, + maxH: 0, // max height of current 'row' + }, + } + ).panels, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/main.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/main.libsonnet new file mode 100644 index 0000000..78fe95f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/main.libsonnet @@ -0,0 +1,9 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.package.newSub('util', 'Helper functions that work well with Grafonnet.'), + dashboard: (import './dashboard.libsonnet'), + grid: (import './grid.libsonnet'), + panel: (import './panel.libsonnet'), + string: (import './string.libsonnet'), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet new file mode 100644 index 0000000..89e0bd7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/panel.libsonnet @@ -0,0 +1,420 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local this = self, + + // used in ../dashboard.libsonnet + '#setPanelIDs':: d.func.new( + ||| + `setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + + `overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('overrideExistingIDs', d.T.bool, default=true), + ] + ), + setPanelIDs(panels, overrideExistingIDs=true): + local infunc(panels, start=1) = + std.foldl( + function(acc, panel) + acc + { + index: // Track the index to ensure no duplicates exist. + acc.index + + 1 + + (if panel.type == 'row' + && 'panels' in panel + then std.length(panel.panels) + else 0), + + panels+: [ + panel + + ( + if overrideExistingIDs + || std.get(panel, 'id', null) == null + then { id: acc.index } + else {} + ) + + ( + if panel.type == 'row' + && 'panels' in panel + then { + panels: + infunc( + panel.panels, + acc.index + 1 + ), + } + else {} + ), + ], + }, + panels, + { index: start, panels: [] } + ).panels; + infunc(panels), + + '#getPanelIDs':: d.func.new( + ||| + `getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + getPanelIDs(panels): + std.flattenArrays( + std.map( + function(panel) + [panel.id] + + (if panel.type == 'row' + then this.getPanelIDs(std.get(panel, 'panels', [])) + else []), + panels + ) + ), + + '#validatePanelIDs':: d.func.new( + ||| + `validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + validatePanelIDs(panels): + local ids = this.getPanelIDs(panels); + std.set(ids) == std.sort(ids), + + '#sanitizePanel':: d.func.new( + ||| + `sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + + The default values for x,y,h,w are only applied if not already set. + |||, + [ + d.arg('panel', d.T.object), + d.arg('defaultX', d.T.number, default=0), + d.arg('defaultY', d.T.number, default=0), + d.arg('defaultHeight', d.T.number, default=8), + d.arg('defaultWidth', d.T.number, default=8), + ] + ), + sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8): + local infunc(panel) = + panel + + ( + local gridPos = std.get(panel, 'gridPos', {}); + if panel.type == 'row' + then { + collapsed: std.get(panel, 'collapsed', false), + panels: std.map(infunc, std.get(panel, 'panels', [])), + gridPos: { // x, h, w are fixed + x: 0, + y: std.get(gridPos, 'y', defaultY), + h: 1, + w: 24, + }, + } + else { + gridPos: { + x: std.get(gridPos, 'x', defaultX), + y: std.get(gridPos, 'y', defaultY), + h: std.get(gridPos, 'h', defaultHeight), + w: std.get(gridPos, 'w', defaultWidth), + }, + } + ); + infunc(panel), + + '#sortPanelsByXY':: d.func.new( + ||| + `sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + sortPanelsByXY(panels): + std.sort( + std.sort( + panels, + function(panel) + panel.gridPos.x + ), + function(panel) + panel.gridPos.y + ), + + '#sortPanelsInRow':: d.func.new( + ||| + `sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + sortPanelsInRow(rowPanel): + rowPanel + { panels: this.sortPanelsByXY(rowPanel.panels) }, + + '#groupPanelsInRows':: d.func.new( + ||| + `groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + groupPanelsInRows(panels): + // Add panels that come after a row to row.panels + local grouped = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) + p + { + panels+: + this.getPanelsBeforeNextRow(panels[i + 1:]), + }, + panels, + ); + + // Get panels that come before the rowGroups + local panelsBeforeRowGroups = this.getPanelsBeforeNextRow(panels); + + panelsBeforeRowGroups + grouped, + + '#getPanelsBeforeNextRow':: d.func.new( + ||| + `getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + getPanelsBeforeNextRow(panels): + local rowIndexes = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) i, + panels, + ); + if std.length(rowIndexes) != 0 + then panels[0:rowIndexes[0]] + else panels[0:], // if no row panels found, return all remaining panels + + '#resolveCollapsedFlagOnRows':: d.func.new( + ||| + `resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + resolveCollapsedFlagOnRows(panels): + std.foldl( + function(acc, panel) + acc + ( + if panel.type == 'row' + && !panel.collapsed + then // If not collapsed, then move panels to main array below the row panel + [panel + { panels: [] }] + + panel.panels + else [panel] + ), + panels, + [], + ), + + '#normalizeY':: d.func.new( + ||| + `normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + + This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + normalizeY(panels): + std.foldl( + function(acc, i) + acc + [ + panels[i] + { + gridPos+: { + y: this.calculateLowestYforPanel(panels[i], acc), + }, + }, + ], + std.range(0, std.length(panels) - 1), + [] + ), + + '#calculateLowestYforPanel':: d.func.new( + ||| + `calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + |||, + [ + d.arg('panel', d.T.object), + d.arg('panels', d.T.array), + ] + ), + calculateLowestYforPanel(panel, panels): + xtd.number.maxInArray( // the new position is highest value (max) on the Y-scale + std.filterMap( + function(p) // find panels that overlap on X-scale + local v1 = panel.gridPos.x; + local v2 = panel.gridPos.x + panel.gridPos.w; + local x1 = p.gridPos.x; + local x2 = p.gridPos.x + p.gridPos.w; + (v1 >= x1 && v1 < x2) + || (v2 >= x1 && v2 < x2), + function(p) // return new position on Y-scale + p.gridPos.y + p.gridPos.h, + panels, + ), + ), + + '#normalizeYInRow':: d.func.new( + ||| + `normalizeYInRow` applies `normalizeY` to the panels in a row panel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + normalizeYInRow(rowPanel): + rowPanel + { + panels: + std.map( + function(p) + p + { + gridPos+: { + y: // Increase panel Y with the row Y to put them below the row when not collapsed. + p.gridPos.y + + rowPanel.gridPos.y + + rowPanel.gridPos.h, + }, + }, + this.normalizeY(rowPanel.panels) + ), + }, + + '#mapToRows':: d.func.new( + ||| + `mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + |||, + [ + d.arg('func', d.T.func), + d.arg('panels', d.T.array), + ] + ), + mapToRows(func, panels): + std.map( + function(p) + if p.type == 'row' + then func(p) + else p, + panels + ), + + + '#setRefIDs':: d.func.new( + ||| + `setRefIDs` calculates the `refId` field for each target on a panel. + |||, + args=[ + d.arg('panel', d.T.object), + d.arg('overrideExistingIDs', d.T.bool, default=true), + ] + ), + setRefIDs(panel, overrideExistingIDs=true): + local calculateRefID(n) = + // From: https://github.com/grafana/grafana/blob/bffd87107b786930edd091060143ee013843efac/packages/grafana-data/src/query/refId.ts#L15 + local letters = std.map(std.char, std.range(std.codepoint('A'), std.codepoint('Z'))); + if n < std.length(letters) + then letters[n] + else calculateRefID(std.floor(n / std.length(letters)) - 1) + letters[std.mod(n, std.length(letters))]; + panel + { + targets: + std.mapWithIndex( + function(i, target) + if overrideExistingIDs + || !std.objectHas(target, 'refId') + then target + { + refId: calculateRefID(i), + } + else target, + panel.targets, + ), + }, + + '#setRefIDsOnPanels':: d.func.new( + ||| + `setRefIDsOnPanels` applies `setRefIDs on all `panels`. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + setRefIDsOnPanels(panels): + std.map(self.setRefIDs, panels), + + '#dedupeQueryTargets':: d.func.new( + ||| + `dedupeQueryTargets` dedupes the query targets in a set of panels and replaces the duplicates with a ['shared query'](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/share-query/). Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard. + + This function requires that the query targets have `refId` set, `setRefIDs` and `setRefIDsOnPanels` can help with that. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + dedupeQueryTargets(panels): + // Hide ref so it doesn't compare in equality + local targetWithoutRef(target) = + target + { refId:: target.refId }; + + // Find targets that are the same + local findTargets(targets, target) = + std.filter( + function(t) + targetWithoutRef(t) == targetWithoutRef(target), + targets + ); + + // Get a flat array of all targets including their panelId + local targets = std.flattenArrays([ + std.map(function(t) t + { panelId:: panel.id }, panel.targets) + for panel in panels + ]); + + std.map( + function(panel) + // Replace target with 'shared query' target if found in other panels + local replaceTarget(target) = + local found = findTargets(targets, target); + if std.length(found) > 0 + // Do not reference queries from the same panel + && found[0].panelId != panel.id + then { + datasource: { + type: 'datasource', + uid: '-- Dashboard --', + }, + refId: found[0].refId, + panelId: found[0].panelId, + } + else target; + + panel + { + targets: + std.map( + replaceTarget, + panel.targets, + ), + }, + panels + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/string.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/string.libsonnet new file mode 100644 index 0000000..ec5a66e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/custom/util/string.libsonnet @@ -0,0 +1,27 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + '#slugify':: d.func.new( + ||| + `slugify` will create a simple slug from `string`, keeping only alphanumeric + characters and replacing spaces with dashes. + |||, + args=[d.arg('string', d.T.string)] + ), + slugify(string): + std.strReplace( + std.asciiLower( + std.join('', [ + string[i] + for i in std.range(0, std.length(string) - 1) + if xtd.ascii.isUpper(string[i]) + || xtd.ascii.isLower(string[i]) + || xtd.ascii.isNumber(string[i]) + || string[i] == ' ' + ]) + ), + ' ', + '-', + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/dashboard.libsonnet new file mode 100644 index 0000000..03d41ec --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/dashboard.libsonnet @@ -0,0 +1,580 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.dashboard', name: 'dashboard' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of dashboard.' } }, + withDescription(value): { + description: value, + }, + '#withEditable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether a dashboard is editable or not.' } }, + withEditable(value=true): { + editable: value, + }, + '#withFiscalYearStartMonth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'The month that the fiscal year starts on. 0 = January, 11 = December' } }, + withFiscalYearStartMonth(value=0): { + fiscalYearStartMonth: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLiveNow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data "moving left" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data' } }, + withLiveNow(value=true): { + liveNow: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefresh(value): { + refresh: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: 36, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.' } }, + withSchemaVersion(value=36): { + schemaVersion: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTemplating': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplating(value): { + templating: value, + }, + '#withTemplatingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplatingMixin(value): { + templating+: value, + }, + '#withTimezone': { 'function': { args: [{ default: 'browser', enums: null, name: 'value', type: ['string'] }], help: 'Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".' } }, + withTimezone(value='browser'): { + timezone: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title of dashboard.' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique dashboard identifier that can be generated by anyone. string (8-40)' } }, + withUid(value): { + uid: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".' } }, + withWeekStart(value): { + weekStart: value, + }, + time+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value='now-6h'): { + time+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value='now'): { + time+: { + to: value, + }, + }, + }, + timepicker+: + { + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is visible or not.' } }, + withHidden(value=true): { + timepicker+: { + hidden: value, + }, + }, + '#withNowDelay': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values.' } }, + withNowDelay(value): { + timepicker+: { + nowDelay: value, + }, + }, + '#withRefreshIntervals': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervals(value): { + timepicker+: { + refresh_intervals: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withRefreshIntervalsMixin': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervalsMixin(value): { + timepicker+: { + refresh_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptions': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptions(value): { + timepicker+: { + time_options: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptionsMixin': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptionsMixin(value): { + timepicker+: { + time_options+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + link+: + { + dashboards+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + link+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + }, + annotation+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withList(value): { + annotations+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withListMixin(value): { + annotations+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withBuiltIn': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Set to 1 for the standard annotation query all dashboards have by default.' } }, + withBuiltIn(value=0): { + builtIn: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEnable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled the annotation query is issued with every dashboard refresh' } }, + withEnable(value=true): { + enable: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withExclude': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Should the specified panels be included or excluded' } }, + withExclude(value=true): { + filter+: { + exclude: value, + }, + }, + '#withIds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIds(value): { + filter+: { + ids: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withIdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIdsMixin(value): { + filter+: { + ids+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.' } }, + withHide(value=true): { + hide: value, + }, + '#withIconColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color to use for the annotation event markers' } }, + withIconColor(value): { + iconColor: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of annotation.' } }, + withName(value): { + name: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withLimit(value): { + target+: { + limit: value, + }, + }, + '#withMatchAny': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withMatchAny(value=true): { + target+: { + matchAny: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTags(value): { + target+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTagsMixin(value): { + target+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withType(value): { + target+: { + type: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO -- this should not exist here, it is based on the --grafana-- datasource' } }, + withType(value): { + type: value, + }, + }, + }, + variable+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withList(value): { + templating+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withListMixin(value): { + templating+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withAllValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom all value' } }, + withAllValue(value): { + allValue: value, + }, + '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrent(value): { + current: value, + }, + '#withCurrentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrentMixin(value): { + current+: value, + }, + current+: + { + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + current+: { + selected: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + current+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + current+: { + text+: value, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + current+: { + value: value, + }, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + current+: { + value+: value, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of variable. It can be defined but `null`.' } }, + withDescription(value): { + description: value, + }, + '#withHide': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).' } }, + withHide(value): { + hide: value, + }, + '#withIncludeAll': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether all value option is available or not' } }, + withIncludeAll(value=true): { + includeAll: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display name' } }, + withLabel(value): { + label: value, + }, + '#withMulti': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether multiple values can be selected or not from variable value list' } }, + withMulti(value=true): { + multi: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of variable' } }, + withName(value): { + name: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptions(value): { + options: + (if std.isArray(value) + then value + else [value]), + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptionsMixin(value): { + options+: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#': { help: '', name: 'options' }, + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + selected: value, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + text: value, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + text+: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + value+: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQueryMixin(value): { + query+: value, + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes.' } }, + withRefresh(value): { + refresh: value, + }, + '#withRegex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional field, if you want to extract part of a series name or metric node segment.\nNamed capture groups can be used to separate the display text and value.' } }, + withRegex(value): { + regex: value, + }, + '#withSkipUrlSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the variable value should be managed by URL query params or not' } }, + withSkipUrlSync(value=true): { + skipUrlSync: value, + }, + '#withSort': { 'function': { args: [{ default: null, enums: [0, 1, 2, 3, 4, 5, 6, 7, 8], name: 'value', type: ['string'] }], help: 'Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC\n`7`: Natural ASC\n`8`: Natural DESC' } }, + withSort(value): { + sort: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['query', 'adhoc', 'groupby', 'constant', 'datasource', 'interval', 'textbox', 'custom', 'system'], name: 'value', type: ['string'] }], help: 'Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables' } }, + withType(value): { + type: value, + }, + }, + }, +} ++ (import 'custom/dashboard.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/README.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/README.md new file mode 100644 index 0000000..1795896 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/README.md @@ -0,0 +1,31 @@ +# grafonnet + +Jsonnet library for rendering Grafana resources +## Install + +``` +jb install github.com/grafana/grafonnet/gen/grafonnet-v11.0.0@main +``` + +## Usage + +```jsonnet +local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet" +``` + + +## Subpackages + +* [accesspolicy](accesspolicy/index.md) +* [alerting](alerting/index.md) +* [dashboard](dashboard/index.md) +* [folder](folder.md) +* [librarypanel](librarypanel/index.md) +* [panel](panel/index.md) +* [preferences](preferences.md) +* [publicdashboard](publicdashboard.md) +* [query](query/index.md) +* [role](role.md) +* [rolebinding](rolebinding.md) +* [team](team.md) +* [util](util.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md new file mode 100644 index 0000000..ff3dcfc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/index.md @@ -0,0 +1,156 @@ +# accesspolicy + +grafonnet.accesspolicy + +## Subpackages + +* [rules](rules.md) + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withScopeMixin(value)`](#fn-withscopemixin) +* [`obj role`](#obj-role) + * [`fn withKind(value)`](#fn-rolewithkind) + * [`fn withName(value)`](#fn-rolewithname) + * [`fn withXname(value)`](#fn-rolewithxname) +* [`obj scope`](#obj-scope) + * [`fn withKind(value)`](#fn-scopewithkind) + * [`fn withName(value)`](#fn-scopewithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScopeMixin + +```jsonnet +withScopeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withKind + +```jsonnet +role.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Role"`, `"BuiltinRole"`, `"Team"`, `"User"` + +Policies can apply to roles, teams, or users +Applying policies to individual users is supported, but discouraged +#### fn role.withName + +```jsonnet +role.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn role.withXname + +```jsonnet +role.withXname(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj scope + + +#### fn scope.withKind + +```jsonnet +scope.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn scope.withName + +```jsonnet +scope.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md new file mode 100644 index 0000000..f576339 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/accesspolicy/rules.md @@ -0,0 +1,60 @@ +# rules + + + +## Index + +* [`fn withKind(value="*")`](#fn-withkind) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withVerb(value)`](#fn-withverb) +* [`fn withVerbMixin(value)`](#fn-withverbmixin) + +## Fields + +### fn withKind + +```jsonnet +withKind(value="*") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"*"` + +The kind this rule applies to (dashboards, alert, etc) +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific sub-elements like "alert.rules" or "dashboard.permissions"???? +### fn withVerb + +```jsonnet +withVerb(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" +### fn withVerbMixin + +```jsonnet +withVerbMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md new file mode 100644 index 0000000..c36edb8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/contactPoint.md @@ -0,0 +1,103 @@ +# contactPoint + +grafonnet.alerting.contactPoint + +**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. + + +## Index + +* [`fn withDisableResolveMessage(value=true)`](#fn-withdisableresolvemessage) +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withDisableResolveMessage + +```jsonnet +withDisableResolveMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +EmbeddedContactPoint is the contact point type that is used +by grafanas embedded alertmanager implementation. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +EmbeddedContactPoint is the contact point type that is used +by grafanas embedded alertmanager implementation. +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + +EmbeddedContactPoint is the contact point type that is used +by grafanas embedded alertmanager implementation. +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` + +EmbeddedContactPoint is the contact point type that is used +by grafanas embedded alertmanager implementation. +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +EmbeddedContactPoint is the contact point type that is used +by grafanas embedded alertmanager implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/index.md new file mode 100644 index 0000000..3715aa4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/index.md @@ -0,0 +1,11 @@ +# alerting + +grafonnet.alerting + +## Subpackages + +* [contactPoint](contactPoint.md) +* [muteTiming](muteTiming/index.md) +* [notificationPolicy](notificationPolicy/index.md) +* [notificationTemplate](notificationTemplate.md) +* [ruleGroup](ruleGroup/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md new file mode 100644 index 0000000..3aee846 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/index.md @@ -0,0 +1,48 @@ +# muteTiming + +grafonnet.alerting.muteTiming + +## Subpackages + +* [interval](interval/index.md) + +## Index + +* [`fn withIntervals(value)`](#fn-withintervals) +* [`fn withIntervalsMixin(value)`](#fn-withintervalsmixin) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withIntervals + +```jsonnet +withIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withIntervalsMixin + +```jsonnet +withIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md new file mode 100644 index 0000000..18021fc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/index.md @@ -0,0 +1,48 @@ +# interval + + + +## Subpackages + +* [time_intervals](time_intervals/index.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeIntervals(value)`](#fn-withtimeintervals) +* [`fn withTimeIntervalsMixin(value)`](#fn-withtimeintervalsmixin) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeIntervals + +```jsonnet +withTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimeIntervalsMixin + +```jsonnet +withTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md new file mode 100644 index 0000000..e649ec2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/index.md @@ -0,0 +1,144 @@ +# time_intervals + + + +## Subpackages + +* [times](times.md) + +## Index + +* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) +* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withMonths(value)`](#fn-withmonths) +* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) +* [`fn withTimes(value)`](#fn-withtimes) +* [`fn withTimesMixin(value)`](#fn-withtimesmixin) +* [`fn withWeekdays(value)`](#fn-withweekdays) +* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) +* [`fn withYears(value)`](#fn-withyears) +* [`fn withYearsMixin(value)`](#fn-withyearsmixin) + +## Fields + +### fn withDaysOfMonth + +```jsonnet +withDaysOfMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDaysOfMonthMixin + +```jsonnet +withDaysOfMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMonths + +```jsonnet +withMonths(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMonthsMixin + +```jsonnet +withMonthsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimes + +```jsonnet +withTimes(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimesMixin + +```jsonnet +withTimesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdays + +```jsonnet +withWeekdays(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdaysMixin + +```jsonnet +withWeekdaysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYears + +```jsonnet +withYears(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYearsMixin + +```jsonnet +withYearsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md new file mode 100644 index 0000000..8304969 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/muteTiming/interval/time_intervals/times.md @@ -0,0 +1,32 @@ +# times + + + +## Index + +* [`fn withEndTime(value)`](#fn-withendtime) +* [`fn withStartTime(value)`](#fn-withstarttime) + +## Fields + +### fn withEndTime + +```jsonnet +withEndTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withStartTime + +```jsonnet +withStartTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md new file mode 100644 index 0000000..0007243 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/index.md @@ -0,0 +1,185 @@ +# notificationPolicy + +grafonnet.alerting.notificationPolicy + +## Subpackages + +* [matcher](matcher.md) + +## Index + +* [`fn withContactPoint(value)`](#fn-withcontactpoint) +* [`fn withContinue(value=true)`](#fn-withcontinue) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withGroupInterval(value)`](#fn-withgroupinterval) +* [`fn withGroupWait(value)`](#fn-withgroupwait) +* [`fn withMatchers(value)`](#fn-withmatchers) +* [`fn withMatchersMixin(value)`](#fn-withmatchersmixin) +* [`fn withMuteTimeIntervals(value)`](#fn-withmutetimeintervals) +* [`fn withMuteTimeIntervalsMixin(value)`](#fn-withmutetimeintervalsmixin) +* [`fn withPolicy(value)`](#fn-withpolicy) +* [`fn withPolicyMixin(value)`](#fn-withpolicymixin) +* [`fn withRepeatInterval(value)`](#fn-withrepeatinterval) + +## Fields + +### fn withContactPoint + +```jsonnet +withContactPoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withContinue + +```jsonnet +withContinue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withGroupInterval + +```jsonnet +withGroupInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withGroupWait + +```jsonnet +withGroupWait(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withMatchers + +```jsonnet +withMatchers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMatchersMixin + +```jsonnet +withMatchersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMuteTimeIntervals + +```jsonnet +withMuteTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withMuteTimeIntervalsMixin + +```jsonnet +withMuteTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withPolicy + +```jsonnet +withPolicy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withPolicyMixin + +```jsonnet +withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. +### fn withRepeatInterval + +```jsonnet +withRepeatInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A Route is a node that contains definitions of how to handle alerts. This is modified +from the upstream alertmanager in that it adds the ObjectMatchers property. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md new file mode 100644 index 0000000..7cad0a7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationPolicy/matcher.md @@ -0,0 +1,45 @@ +# matcher + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"="`, `"!="`, `"=~"`, `"!~"` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationTemplate.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationTemplate.md new file mode 100644 index 0000000..47ce2da --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/notificationTemplate.md @@ -0,0 +1,44 @@ +# notificationTemplate + +grafonnet.alerting.notificationTemplate + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withTemplate(value)`](#fn-withtemplate) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTemplate + +```jsonnet +withTemplate(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md new file mode 100644 index 0000000..588ead0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/index.md @@ -0,0 +1,72 @@ +# ruleGroup + +grafonnet.alerting.ruleGroup + +## Subpackages + +* [rule](rule/index.md) + +## Index + +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withName(value)`](#fn-withname) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) + +## Fields + +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md new file mode 100644 index 0000000..abe5cda --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/data.md @@ -0,0 +1,123 @@ +# data + + + +## Index + +* [`fn withDatasourceUid(value)`](#fn-withdatasourceuid) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRelativeTimeRange(value)`](#fn-withrelativetimerange) +* [`fn withRelativeTimeRangeMixin(value)`](#fn-withrelativetimerangemixin) +* [`obj relativeTimeRange`](#obj-relativetimerange) + * [`fn withFrom(value)`](#fn-relativetimerangewithfrom) + * [`fn withTo(value)`](#fn-relativetimerangewithto) + +## Fields + +### fn withDatasourceUid + +```jsonnet +withDatasourceUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRelativeTimeRange + +```jsonnet +withRelativeTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### fn withRelativeTimeRangeMixin + +```jsonnet +withRelativeTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### obj relativeTimeRange + + +#### fn relativeTimeRange.withFrom + +```jsonnet +relativeTimeRange.withFrom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. +#### fn relativeTimeRange.withTo + +```jsonnet +relativeTimeRange.withTo(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md new file mode 100644 index 0000000..27748f0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/alerting/ruleGroup/rule/index.md @@ -0,0 +1,196 @@ +# rule + + + +## Subpackages + +* [data](data.md) + +## Index + +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withCondition(value)`](#fn-withcondition) +* [`fn withData(value)`](#fn-withdata) +* [`fn withDataMixin(value)`](#fn-withdatamixin) +* [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFolderUID(value)`](#fn-withfolderuid) +* [`fn withFor(value)`](#fn-withfor) +* [`fn withIsPaused(value=true)`](#fn-withispaused) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withNoDataState(value)`](#fn-withnodatastate) +* [`fn withOrgID(value)`](#fn-withorgid) +* [`fn withRuleGroup(value)`](#fn-withrulegroup) + +## Fields + +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCondition + +```jsonnet +withCondition(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withData + +```jsonnet +withData(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDataMixin + +```jsonnet +withDataMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withExecErrState + +```jsonnet +withExecErrState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"OK"`, `"Alerting"`, `"Error"` + + +### fn withFolderUID + +```jsonnet +withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withFor + +```jsonnet +withFor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing. +Before this time has elapsed, the rule is only considered to be Pending. +### fn withIsPaused + +```jsonnet +withIsPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelsMixin + +```jsonnet +withLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withNoDataState + +```jsonnet +withNoDataState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Alerting"`, `"NoData"`, `"OK"` + + +### fn withOrgID + +```jsonnet +withOrgID(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withRuleGroup + +```jsonnet +withRuleGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md new file mode 100644 index 0000000..7395529 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/annotation.md @@ -0,0 +1,298 @@ +# annotation + + + +## Index + +* [`fn withBuiltIn(value=0)`](#fn-withbuiltin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEnable(value=true)`](#fn-withenable) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIconColor(value)`](#fn-withiconcolor) +* [`fn withName(value)`](#fn-withname) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj filter`](#obj-filter) + * [`fn withExclude(value=true)`](#fn-filterwithexclude) + * [`fn withIds(value)`](#fn-filterwithids) + * [`fn withIdsMixin(value)`](#fn-filterwithidsmixin) +* [`obj target`](#obj-target) + * [`fn withLimit(value)`](#fn-targetwithlimit) + * [`fn withMatchAny(value=true)`](#fn-targetwithmatchany) + * [`fn withTags(value)`](#fn-targetwithtags) + * [`fn withTagsMixin(value)`](#fn-targetwithtagsmixin) + * [`fn withType(value)`](#fn-targetwithtype) + +## Fields + +### fn withBuiltIn + +```jsonnet +withBuiltIn(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Set to 1 for the standard annotation query all dashboards have by default. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEnable + +```jsonnet +withEnable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled the annotation query is issued with every dashboard refresh +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Annotation queries can be toggled on or off at the top of the dashboard. +When hide is true, the toggle is not shown in the dashboard. +### fn withIconColor + +```jsonnet +withIconColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color to use for the annotation event markers +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of annotation. +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TODO -- this should not exist here, it is based on the --grafana-- datasource +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj filter + + +#### fn filter.withExclude + +```jsonnet +filter.withExclude(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Should the specified panels be included or excluded +#### fn filter.withIds + +```jsonnet +filter.withIds(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +#### fn filter.withIdsMixin + +```jsonnet +filter.withIdsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +### obj target + + +#### fn target.withLimit + +```jsonnet +target.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withMatchAny + +```jsonnet +target.withMatchAny(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTags + +```jsonnet +target.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTagsMixin + +```jsonnet +target.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withType + +```jsonnet +target.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/index.md new file mode 100644 index 0000000..ec78d46 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/index.md @@ -0,0 +1,479 @@ +# dashboard + +grafonnet.dashboard + +## Subpackages + +* [annotation](annotation.md) +* [link](link.md) +* [variable](variable.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withEditable(value=true)`](#fn-witheditable) +* [`fn withFiscalYearStartMonth(value=0)`](#fn-withfiscalyearstartmonth) +* [`fn withLinks(value)`](#fn-withlinks) +* [`fn withLinksMixin(value)`](#fn-withlinksmixin) +* [`fn withLiveNow(value=true)`](#fn-withlivenow) +* [`fn withPanels(panels, setPanelIDs=true)`](#fn-withpanels) +* [`fn withPanelsMixin(panels, setPanelIDs=true)`](#fn-withpanelsmixin) +* [`fn withRefresh(value)`](#fn-withrefresh) +* [`fn withSchemaVersion(value=39)`](#fn-withschemaversion) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTemplating(value)`](#fn-withtemplating) +* [`fn withTemplatingMixin(value)`](#fn-withtemplatingmixin) +* [`fn withTimezone(value="browser")`](#fn-withtimezone) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVariables(value)`](#fn-withvariables) +* [`fn withVariablesMixin(value)`](#fn-withvariablesmixin) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj graphTooltip`](#obj-graphtooltip) + * [`fn withSharedCrosshair()`](#fn-graphtooltipwithsharedcrosshair) + * [`fn withSharedTooltip()`](#fn-graphtooltipwithsharedtooltip) +* [`obj time`](#obj-time) + * [`fn withFrom(value="now-6h")`](#fn-timewithfrom) + * [`fn withTo(value="now")`](#fn-timewithto) +* [`obj timepicker`](#obj-timepicker) + * [`fn withHidden(value=true)`](#fn-timepickerwithhidden) + * [`fn withNowDelay(value)`](#fn-timepickerwithnowdelay) + * [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals) + * [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin) + * [`fn withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptions) + * [`fn withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptionsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboard with a title. +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotations` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotationsMixin` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of dashboard. +### fn withEditable + +```jsonnet +withEditable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether a dashboard is editable or not. +### fn withFiscalYearStartMonth + +```jsonnet +withFiscalYearStartMonth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +The month that the fiscal year starts on. 0 = January, 11 = December +### fn withLinks + +```jsonnet +withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLinksMixin + +```jsonnet +withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLiveNow + +```jsonnet +withLiveNow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When set to true, the dashboard will redraw panels at an interval matching the pixel width. +This will keep data "moving left" regardless of the query refresh rate. This setting helps +avoid dashboards presenting stale live data +### fn withPanels + +```jsonnet +withPanels(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`. +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanelsMixin` adds more panels to a dashboard. +### fn withRefresh + +```jsonnet +withRefresh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value=39) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `39` + + +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTemplating + +```jsonnet +withTemplating(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTemplatingMixin + +```jsonnet +withTemplatingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTimezone + +```jsonnet +withTimezone(value="browser") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"browser"` + +Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc". +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title of dashboard. +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique dashboard identifier that can be generated by anyone. string (8-40) +### fn withVariables + +```jsonnet +withVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariables` adds an array of variables to a dashboard + +### fn withVariablesMixin + +```jsonnet +withVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariablesMixin` adds an array of variables to a dashboard. + +This function appends passed data to existing values + +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday". +### obj graphTooltip + + +#### fn graphTooltip.withSharedCrosshair + +```jsonnet +graphTooltip.withSharedCrosshair() +``` + + +Share crosshair on all panels. +#### fn graphTooltip.withSharedTooltip + +```jsonnet +graphTooltip.withSharedTooltip() +``` + + +Share crosshair and tooltip on all panels. +### obj time + + +#### fn time.withFrom + +```jsonnet +time.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + + +#### fn time.withTo + +```jsonnet +time.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + + +### obj timepicker + + +#### fn timepicker.withHidden + +```jsonnet +timepicker.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether timepicker is visible or not. +#### fn timepicker.withNowDelay + +```jsonnet +timepicker.withNowDelay(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values. +#### fn timepicker.withRefreshIntervals + +```jsonnet +timepicker.withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withRefreshIntervalsMixin + +```jsonnet +timepicker.withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withTimeOptions + +```jsonnet +timepicker.withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. +#### fn timepicker.withTimeOptionsMixin + +```jsonnet +timepicker.withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/link.md new file mode 100644 index 0000000..421e0c0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/link.md @@ -0,0 +1,196 @@ +# link + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + + +## Index + +* [`obj dashboards`](#obj-dashboards) + * [`fn new(title, tags)`](#fn-dashboardsnew) + * [`obj options`](#obj-dashboardsoptions) + * [`fn withAsDropdown(value=true)`](#fn-dashboardsoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-dashboardsoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-dashboardsoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-dashboardsoptionswithtargetblank) +* [`obj link`](#obj-link) + * [`fn new(title, url)`](#fn-linknew) + * [`fn withIcon(value)`](#fn-linkwithicon) + * [`fn withTooltip(value)`](#fn-linkwithtooltip) + * [`obj options`](#obj-linkoptions) + * [`fn withAsDropdown(value=true)`](#fn-linkoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-linkoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-linkoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-linkoptionswithtargetblank) + +## Fields + +### obj dashboards + + +#### fn dashboards.new + +```jsonnet +dashboards.new(title, tags) +``` + +PARAMETERS: + +* **title** (`string`) +* **tags** (`array`) + +Create links to dashboards based on `tags`. + +#### obj dashboards.options + + +##### fn dashboards.options.withAsDropdown + +```jsonnet +dashboards.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +##### fn dashboards.options.withIncludeVars + +```jsonnet +dashboards.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn dashboards.options.withKeepTime + +```jsonnet +dashboards.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn dashboards.options.withTargetBlank + +```jsonnet +dashboards.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### obj link + + +#### fn link.new + +```jsonnet +link.new(title, url) +``` + +PARAMETERS: + +* **title** (`string`) +* **url** (`string`) + +Create link to an arbitrary URL. + +#### fn link.withIcon + +```jsonnet +link.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +#### fn link.withTooltip + +```jsonnet +link.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +#### obj link.options + + +##### fn link.options.withAsDropdown + +```jsonnet +link.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +##### fn link.options.withIncludeVars + +```jsonnet +link.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn link.options.withKeepTime + +```jsonnet +link.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn link.options.withTargetBlank + +```jsonnet +link.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/variable.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/variable.md new file mode 100644 index 0000000..e5114ea --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/dashboard/variable.md @@ -0,0 +1,1054 @@ +# variable + +Example usage: + +```jsonnet +local g = import 'g.libsonnet'; +local var = g.dashboard.variable; + +local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + +local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + +g.dashboard.new('my dashboard') ++ g.dashboard.withVariables([ + customVar, + queryVar, +]) +``` + + +## Index + +* [`obj adhoc`](#obj-adhoc) + * [`fn new(name, type, uid)`](#fn-adhocnew) + * [`fn newFromDatasourceVariable(name, variable)`](#fn-adhocnewfromdatasourcevariable) + * [`obj generalOptions`](#obj-adhocgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-adhocgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-adhocgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-adhocgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-adhocgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-adhocgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-adhocgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-adhocgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-adhocgeneraloptionsshowondashboardwithvalueonly) +* [`obj constant`](#obj-constant) + * [`fn new(name, value)`](#fn-constantnew) + * [`obj generalOptions`](#obj-constantgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-constantgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-constantgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-constantgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-constantgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-constantgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-constantgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-constantgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-constantgeneraloptionsshowondashboardwithvalueonly) +* [`obj custom`](#obj-custom) + * [`fn new(name, values)`](#fn-customnew) + * [`obj generalOptions`](#obj-customgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-customgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-customgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-customgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-customgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-customgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-customgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-customgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-customgeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-customselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-customselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-customselectionoptionswithmulti) +* [`obj datasource`](#obj-datasource) + * [`fn new(name, type)`](#fn-datasourcenew) + * [`fn withRegex(value)`](#fn-datasourcewithregex) + * [`obj generalOptions`](#obj-datasourcegeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-datasourcegeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-datasourcegeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-datasourcegeneraloptionswithlabel) + * [`fn withName(value)`](#fn-datasourcegeneraloptionswithname) + * [`obj showOnDashboard`](#obj-datasourcegeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-datasourcegeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-datasourcegeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-datasourcegeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-datasourceselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-datasourceselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-datasourceselectionoptionswithmulti) +* [`obj interval`](#obj-interval) + * [`fn new(name, values)`](#fn-intervalnew) + * [`fn withAutoOption(count, minInterval)`](#fn-intervalwithautooption) + * [`obj generalOptions`](#obj-intervalgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-intervalgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-intervalgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-intervalgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-intervalgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-intervalgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-intervalgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-intervalgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-intervalgeneraloptionsshowondashboardwithvalueonly) +* [`obj query`](#obj-query) + * [`fn new(name, query="")`](#fn-querynew) + * [`fn withDatasource(type, uid)`](#fn-querywithdatasource) + * [`fn withDatasourceFromVariable(variable)`](#fn-querywithdatasourcefromvariable) + * [`fn withRegex(value)`](#fn-querywithregex) + * [`fn withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false)`](#fn-querywithsort) + * [`obj generalOptions`](#obj-querygeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-querygeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-querygeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-querygeneraloptionswithlabel) + * [`fn withName(value)`](#fn-querygeneraloptionswithname) + * [`obj showOnDashboard`](#obj-querygeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-querygeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-querygeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly) + * [`obj queryTypes`](#obj-queryquerytypes) + * [`fn withLabelValues(label, metric="")`](#fn-queryquerytypeswithlabelvalues) + * [`fn withQueryResult(query)`](#fn-queryquerytypeswithqueryresult) + * [`obj refresh`](#obj-queryrefresh) + * [`fn onLoad()`](#fn-queryrefreshonload) + * [`fn onTime()`](#fn-queryrefreshontime) + * [`obj selectionOptions`](#obj-queryselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-queryselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-queryselectionoptionswithmulti) +* [`obj textbox`](#obj-textbox) + * [`fn new(name, default="")`](#fn-textboxnew) + * [`obj generalOptions`](#obj-textboxgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-textboxgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-textboxgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-textboxgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-textboxgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-textboxgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-textboxgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-textboxgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-textboxgeneraloptionsshowondashboardwithvalueonly) + +## Fields + +### obj adhoc + + +#### fn adhoc.new + +```jsonnet +adhoc.new(name, type, uid) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **uid** (`string`) + +`new` creates an adhoc template variable for datasource with `type` and `uid`. +#### fn adhoc.newFromDatasourceVariable + +```jsonnet +adhoc.newFromDatasourceVariable(name, variable) +``` + +PARAMETERS: + +* **name** (`string`) +* **variable** (`object`) + +Same as `new` but selecting the datasource from another template variable. +#### obj adhoc.generalOptions + + +##### fn adhoc.generalOptions.withCurrent + +```jsonnet +adhoc.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn adhoc.generalOptions.withDescription + +```jsonnet +adhoc.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn adhoc.generalOptions.withLabel + +```jsonnet +adhoc.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn adhoc.generalOptions.withName + +```jsonnet +adhoc.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj adhoc.generalOptions.showOnDashboard + + +###### fn adhoc.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +adhoc.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withNothing + +```jsonnet +adhoc.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +adhoc.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj constant + + +#### fn constant.new + +```jsonnet +constant.new(name, value) +``` + +PARAMETERS: + +* **name** (`string`) +* **value** (`string`) + +`new` creates a hidden constant template variable. +#### obj constant.generalOptions + + +##### fn constant.generalOptions.withCurrent + +```jsonnet +constant.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn constant.generalOptions.withDescription + +```jsonnet +constant.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn constant.generalOptions.withLabel + +```jsonnet +constant.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn constant.generalOptions.withName + +```jsonnet +constant.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj constant.generalOptions.showOnDashboard + + +###### fn constant.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +constant.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withNothing + +```jsonnet +constant.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +constant.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj custom + + +#### fn custom.new + +```jsonnet +custom.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates a custom template variable. + +The `values` array accepts an object with key/value keys, if it's not an object +then it will be added as a string. + +Example: +``` +[ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, +] + +#### obj custom.generalOptions + + +##### fn custom.generalOptions.withCurrent + +```jsonnet +custom.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn custom.generalOptions.withDescription + +```jsonnet +custom.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn custom.generalOptions.withLabel + +```jsonnet +custom.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn custom.generalOptions.withName + +```jsonnet +custom.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj custom.generalOptions.showOnDashboard + + +###### fn custom.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +custom.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withNothing + +```jsonnet +custom.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +custom.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj custom.selectionOptions + + +##### fn custom.selectionOptions.withIncludeAll + +```jsonnet +custom.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn custom.selectionOptions.withMulti + +```jsonnet +custom.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj datasource + + +#### fn datasource.new + +```jsonnet +datasource.new(name, type) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) + +`new` creates a datasource template variable. +#### fn datasource.withRegex + +```jsonnet +datasource.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` filter for which data source instances to choose from in the +variable value list. Example: `/^prod/` + +#### obj datasource.generalOptions + + +##### fn datasource.generalOptions.withCurrent + +```jsonnet +datasource.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn datasource.generalOptions.withDescription + +```jsonnet +datasource.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn datasource.generalOptions.withLabel + +```jsonnet +datasource.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn datasource.generalOptions.withName + +```jsonnet +datasource.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj datasource.generalOptions.showOnDashboard + + +###### fn datasource.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +datasource.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withNothing + +```jsonnet +datasource.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +datasource.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj datasource.selectionOptions + + +##### fn datasource.selectionOptions.withIncludeAll + +```jsonnet +datasource.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn datasource.selectionOptions.withMulti + +```jsonnet +datasource.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj interval + + +#### fn interval.new + +```jsonnet +interval.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates an interval template variable. +#### fn interval.withAutoOption + +```jsonnet +interval.withAutoOption(count, minInterval) +``` + +PARAMETERS: + +* **count** (`number`) +* **minInterval** (`string`) + +`withAutoOption` adds an options to dynamically calculate interval by dividing +time range by the count specified. + +`minInterval' has to be either unit-less or end with one of the following units: +"y, M, w, d, h, m, s, ms". + +#### obj interval.generalOptions + + +##### fn interval.generalOptions.withCurrent + +```jsonnet +interval.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn interval.generalOptions.withDescription + +```jsonnet +interval.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn interval.generalOptions.withLabel + +```jsonnet +interval.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn interval.generalOptions.withName + +```jsonnet +interval.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj interval.generalOptions.showOnDashboard + + +###### fn interval.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +interval.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withNothing + +```jsonnet +interval.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +interval.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj query + + +#### fn query.new + +```jsonnet +query.new(name, query="") +``` + +PARAMETERS: + +* **name** (`string`) +* **query** (`string`) + - default value: `""` + +Create a query template variable. + +`query` argument is optional, this can also be set with `query.queryTypes`. + +#### fn query.withDatasource + +```jsonnet +query.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +Select a datasource for the variable template query. +#### fn query.withDatasourceFromVariable + +```jsonnet +query.withDatasourceFromVariable(variable) +``` + +PARAMETERS: + +* **variable** (`object`) + +Select the datasource from another template variable. +#### fn query.withRegex + +```jsonnet +query.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` can extract part of a series name or metric node segment. Named +capture groups can be used to separate the display text and value +([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + +#### fn query.withSort + +```jsonnet +query.withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) +``` + +PARAMETERS: + +* **i** (`number`) + - default value: `0` +* **type** (`string`) + - default value: `"alphabetical"` +* **asc** (`bool`) + - default value: `true` +* **caseInsensitive** (`bool`) + - default value: `false` + +Choose how to sort the values in the dropdown. + +This can be called as `withSort() to use the integer values for each +option. If `i==0` then it will be ignored and the other arguments will take +precedence. + +The numerical values are: + +- 1 - Alphabetical (asc) +- 2 - Alphabetical (desc) +- 3 - Numerical (asc) +- 4 - Numerical (desc) +- 5 - Alphabetical (case-insensitive, asc) +- 6 - Alphabetical (case-insensitive, desc) + +#### obj query.generalOptions + + +##### fn query.generalOptions.withCurrent + +```jsonnet +query.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn query.generalOptions.withDescription + +```jsonnet +query.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn query.generalOptions.withLabel + +```jsonnet +query.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn query.generalOptions.withName + +```jsonnet +query.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj query.generalOptions.showOnDashboard + + +###### fn query.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +query.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn query.generalOptions.showOnDashboard.withNothing + +```jsonnet +query.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn query.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +query.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj query.queryTypes + + +##### fn query.queryTypes.withLabelValues + +```jsonnet +query.queryTypes.withLabelValues(label, metric="") +``` + +PARAMETERS: + +* **label** (`string`) +* **metric** (`string`) + - default value: `""` + +Construct a Prometheus template variable using `label_values()`. +##### fn query.queryTypes.withQueryResult + +```jsonnet +query.queryTypes.withQueryResult(query) +``` + +PARAMETERS: + +* **query** (`string`) + +Construct a Prometheus template variable using `query_result()`. +#### obj query.refresh + + +##### fn query.refresh.onLoad + +```jsonnet +query.refresh.onLoad() +``` + + +Refresh label values on dashboard load. +##### fn query.refresh.onTime + +```jsonnet +query.refresh.onTime() +``` + + +Refresh label values on time range change. +#### obj query.selectionOptions + + +##### fn query.selectionOptions.withIncludeAll + +```jsonnet +query.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn query.selectionOptions.withMulti + +```jsonnet +query.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj textbox + + +#### fn textbox.new + +```jsonnet +textbox.new(name, default="") +``` + +PARAMETERS: + +* **name** (`string`) +* **default** (`string`) + - default value: `""` + +`new` creates a textbox template variable. +#### obj textbox.generalOptions + + +##### fn textbox.generalOptions.withCurrent + +```jsonnet +textbox.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn textbox.generalOptions.withDescription + +```jsonnet +textbox.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn textbox.generalOptions.withLabel + +```jsonnet +textbox.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn textbox.generalOptions.withName + +```jsonnet +textbox.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj textbox.generalOptions.showOnDashboard + + +###### fn textbox.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +textbox.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withNothing + +```jsonnet +textbox.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +textbox.generalOptions.showOnDashboard.withValueOnly() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/folder.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/folder.md new file mode 100644 index 0000000..ffab037 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/folder.md @@ -0,0 +1,45 @@ +# folder + +grafonnet.folder + +## Index + +* [`fn withParentUid(value)`](#fn-withparentuid) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withParentUid + +```jsonnet +withParentUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +only used if nested folders are enabled +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder title +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique folder id \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/index.md new file mode 100644 index 0000000..0592b47 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/index.md @@ -0,0 +1,1599 @@ +# librarypanel + +grafonnet.librarypanel + +## Subpackages + +* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) +* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) +* [model.links](model/links.md) +* [model.transformations](model/transformations.md) + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withMeta(value)`](#fn-withmeta) +* [`fn withMetaMixin(value)`](#fn-withmetamixin) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withSchemaVersion(value)`](#fn-withschemaversion) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVersion(value)`](#fn-withversion) +* [`obj meta`](#obj-meta) + * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) + * [`fn withCreated(value)`](#fn-metawithcreated) + * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) + * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) + * [`fn withFolderName(value)`](#fn-metawithfoldername) + * [`fn withFolderUid(value)`](#fn-metawithfolderuid) + * [`fn withUpdated(value)`](#fn-metawithupdated) + * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) + * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) + * [`obj createdBy`](#obj-metacreatedby) + * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) + * [`fn withId(value)`](#fn-metacreatedbywithid) + * [`fn withName(value)`](#fn-metacreatedbywithname) + * [`obj updatedBy`](#obj-metaupdatedby) + * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) + * [`fn withId(value)`](#fn-metaupdatedbywithid) + * [`fn withName(value)`](#fn-metaupdatedbywithname) +* [`obj model`](#obj-model) + * [`fn withCacheTimeout(value)`](#fn-modelwithcachetimeout) + * [`fn withDatasource(value)`](#fn-modelwithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-modelwithdatasourcemixin) + * [`fn withDescription(value)`](#fn-modelwithdescription) + * [`fn withFieldConfig(value)`](#fn-modelwithfieldconfig) + * [`fn withFieldConfigMixin(value)`](#fn-modelwithfieldconfigmixin) + * [`fn withHideTimeOverride(value=true)`](#fn-modelwithhidetimeoverride) + * [`fn withInterval(value)`](#fn-modelwithinterval) + * [`fn withLinks(value)`](#fn-modelwithlinks) + * [`fn withLinksMixin(value)`](#fn-modelwithlinksmixin) + * [`fn withMaxDataPoints(value)`](#fn-modelwithmaxdatapoints) + * [`fn withMaxPerRow(value)`](#fn-modelwithmaxperrow) + * [`fn withOptions(value)`](#fn-modelwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelwithoptionsmixin) + * [`fn withPluginVersion(value)`](#fn-modelwithpluginversion) + * [`fn withQueryCachingTTL(value)`](#fn-modelwithquerycachingttl) + * [`fn withRepeat(value)`](#fn-modelwithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-modelwithrepeatdirection) + * [`fn withTargets(value)`](#fn-modelwithtargets) + * [`fn withTargetsMixin(value)`](#fn-modelwithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-modelwithtimefrom) + * [`fn withTimeShift(value)`](#fn-modelwithtimeshift) + * [`fn withTitle(value)`](#fn-modelwithtitle) + * [`fn withTransformations(value)`](#fn-modelwithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-modelwithtransformationsmixin) + * [`fn withTransparent(value=true)`](#fn-modelwithtransparent) + * [`fn withType(value)`](#fn-modelwithtype) + * [`obj datasource`](#obj-modeldatasource) + * [`fn withType(value)`](#fn-modeldatasourcewithtype) + * [`fn withUid(value)`](#fn-modeldatasourcewithuid) + * [`obj fieldConfig`](#obj-modelfieldconfig) + * [`fn withDefaults(value)`](#fn-modelfieldconfigwithdefaults) + * [`fn withDefaultsMixin(value)`](#fn-modelfieldconfigwithdefaultsmixin) + * [`fn withOverrides(value)`](#fn-modelfieldconfigwithoverrides) + * [`fn withOverridesMixin(value)`](#fn-modelfieldconfigwithoverridesmixin) + * [`obj defaults`](#obj-modelfieldconfigdefaults) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultswithcolor) + * [`fn withColorMixin(value)`](#fn-modelfieldconfigdefaultswithcolormixin) + * [`fn withCustom(value)`](#fn-modelfieldconfigdefaultswithcustom) + * [`fn withCustomMixin(value)`](#fn-modelfieldconfigdefaultswithcustommixin) + * [`fn withDecimals(value)`](#fn-modelfieldconfigdefaultswithdecimals) + * [`fn withDescription(value)`](#fn-modelfieldconfigdefaultswithdescription) + * [`fn withDisplayName(value)`](#fn-modelfieldconfigdefaultswithdisplayname) + * [`fn withDisplayNameFromDS(value)`](#fn-modelfieldconfigdefaultswithdisplaynamefromds) + * [`fn withFilterable(value=true)`](#fn-modelfieldconfigdefaultswithfilterable) + * [`fn withLinks(value)`](#fn-modelfieldconfigdefaultswithlinks) + * [`fn withLinksMixin(value)`](#fn-modelfieldconfigdefaultswithlinksmixin) + * [`fn withMappings(value)`](#fn-modelfieldconfigdefaultswithmappings) + * [`fn withMappingsMixin(value)`](#fn-modelfieldconfigdefaultswithmappingsmixin) + * [`fn withMax(value)`](#fn-modelfieldconfigdefaultswithmax) + * [`fn withMin(value)`](#fn-modelfieldconfigdefaultswithmin) + * [`fn withNoValue(value)`](#fn-modelfieldconfigdefaultswithnovalue) + * [`fn withPath(value)`](#fn-modelfieldconfigdefaultswithpath) + * [`fn withThresholds(value)`](#fn-modelfieldconfigdefaultswiththresholds) + * [`fn withThresholdsMixin(value)`](#fn-modelfieldconfigdefaultswiththresholdsmixin) + * [`fn withUnit(value)`](#fn-modelfieldconfigdefaultswithunit) + * [`fn withWriteable(value=true)`](#fn-modelfieldconfigdefaultswithwriteable) + * [`obj color`](#obj-modelfieldconfigdefaultscolor) + * [`fn withFixedColor(value)`](#fn-modelfieldconfigdefaultscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-modelfieldconfigdefaultscolorwithseriesby) + * [`obj mappings`](#obj-modelfieldconfigdefaultsmappings) + * [`obj RangeMap`](#obj-modelfieldconfigdefaultsmappingsrangemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsrangemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsrangemapoptions) + * [`fn withFrom(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithto) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsrangemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithtext) + * [`obj RegexMap`](#obj-modelfieldconfigdefaultsmappingsregexmap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsregexmapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsregexmapoptions) + * [`fn withPattern(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsregexmapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithtext) + * [`obj SpecialValueMap`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptions) + * [`fn withMatch(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithtext) + * [`obj ValueMap`](#obj-modelfieldconfigdefaultsmappingsvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithtype) + * [`obj thresholds`](#obj-modelfieldconfigdefaultsthresholds) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultsthresholdswithmode) + * [`fn withSteps(value)`](#fn-modelfieldconfigdefaultsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-modelfieldconfigdefaultsthresholdswithstepsmixin) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder UID +### fn withMeta + +```jsonnet +withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withMetaMixin + +```jsonnet +withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: should be the same panel schema defined in dashboard +Typescript: Omit; +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel name (also saved in the model) +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Dashboard version when this was saved (zero if unknown) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel type (from inside the model) +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library element UID +### fn withVersion + +```jsonnet +withVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +panel version, incremented each time the dashboard is updated. +### obj meta + + +#### fn meta.withConnectedDashboards + +```jsonnet +meta.withConnectedDashboards(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn meta.withCreated + +```jsonnet +meta.withCreated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withCreatedBy + +```jsonnet +meta.withCreatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withCreatedByMixin + +```jsonnet +meta.withCreatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withFolderName + +```jsonnet +meta.withFolderName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withFolderUid + +```jsonnet +meta.withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdated + +```jsonnet +meta.withUpdated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdatedBy + +```jsonnet +meta.withUpdatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withUpdatedByMixin + +```jsonnet +meta.withUpdatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj meta.createdBy + + +##### fn meta.createdBy.withAvatarUrl + +```jsonnet +meta.createdBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.createdBy.withId + +```jsonnet +meta.createdBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.createdBy.withName + +```jsonnet +meta.createdBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj meta.updatedBy + + +##### fn meta.updatedBy.withAvatarUrl + +```jsonnet +meta.updatedBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.updatedBy.withId + +```jsonnet +meta.updatedBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.updatedBy.withName + +```jsonnet +meta.updatedBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj model + + +#### fn model.withCacheTimeout + +```jsonnet +model.withCacheTimeout(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets panel queries cache timeout. +#### fn model.withDatasource + +```jsonnet +model.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDatasourceMixin + +```jsonnet +model.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDescription + +```jsonnet +model.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn model.withFieldConfig + +```jsonnet +model.withFieldConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withFieldConfigMixin + +```jsonnet +model.withFieldConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withHideTimeOverride + +```jsonnet +model.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn model.withInterval + +```jsonnet +model.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withLinks + +```jsonnet +model.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withLinksMixin + +```jsonnet +model.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withMaxDataPoints + +```jsonnet +model.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn model.withMaxPerRow + +```jsonnet +model.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn model.withOptions + +```jsonnet +model.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withOptionsMixin + +```jsonnet +model.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withPluginVersion + +```jsonnet +model.withPluginVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs. +#### fn model.withQueryCachingTTL + +```jsonnet +model.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn model.withRepeat + +```jsonnet +model.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn model.withRepeatDirection + +```jsonnet +model.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn model.withTargets + +```jsonnet +model.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTargetsMixin + +```jsonnet +model.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTimeFrom + +```jsonnet +model.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTimeShift + +```jsonnet +model.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTitle + +```jsonnet +model.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn model.withTransformations + +```jsonnet +model.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransformationsMixin + +```jsonnet +model.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransparent + +```jsonnet +model.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +#### fn model.withType + +```jsonnet +model.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel plugin type id. This is used to find the plugin to display the panel. +#### obj model.datasource + + +##### fn model.datasource.withType + +```jsonnet +model.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn model.datasource.withUid + +```jsonnet +model.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +#### obj model.fieldConfig + + +##### fn model.fieldConfig.withDefaults + +```jsonnet +model.fieldConfig.withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withDefaultsMixin + +```jsonnet +model.fieldConfig.withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withOverrides + +```jsonnet +model.fieldConfig.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### fn model.fieldConfig.withOverridesMixin + +```jsonnet +model.fieldConfig.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### obj model.fieldConfig.defaults + + +###### fn model.fieldConfig.defaults.withColor + +```jsonnet +model.fieldConfig.defaults.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withColorMixin + +```jsonnet +model.fieldConfig.defaults.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withCustom + +```jsonnet +model.fieldConfig.defaults.withCustom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withCustomMixin + +```jsonnet +model.fieldConfig.defaults.withCustomMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withDecimals + +```jsonnet +model.fieldConfig.defaults.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +###### fn model.fieldConfig.defaults.withDescription + +```jsonnet +model.fieldConfig.defaults.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Human readable field metadata +###### fn model.fieldConfig.defaults.withDisplayName + +```jsonnet +model.fieldConfig.defaults.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +###### fn model.fieldConfig.defaults.withDisplayNameFromDS + +```jsonnet +model.fieldConfig.defaults.withDisplayNameFromDS(value) +``` + +PARAMETERS: + +* **value** (`string`) + +This can be used by data sources that return and explicit naming structure for values and labels +When this property is configured, this value is used rather than the default naming strategy. +###### fn model.fieldConfig.defaults.withFilterable + +```jsonnet +model.fieldConfig.defaults.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +###### fn model.fieldConfig.defaults.withLinks + +```jsonnet +model.fieldConfig.defaults.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withLinksMixin + +```jsonnet +model.fieldConfig.defaults.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withMappings + +```jsonnet +model.fieldConfig.defaults.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMappingsMixin + +```jsonnet +model.fieldConfig.defaults.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMax + +```jsonnet +model.fieldConfig.defaults.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withMin + +```jsonnet +model.fieldConfig.defaults.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withNoValue + +```jsonnet +model.fieldConfig.defaults.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +###### fn model.fieldConfig.defaults.withPath + +```jsonnet +model.fieldConfig.defaults.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +###### fn model.fieldConfig.defaults.withThresholds + +```jsonnet +model.fieldConfig.defaults.withThresholds(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withThresholdsMixin + +```jsonnet +model.fieldConfig.defaults.withThresholdsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withUnit + +```jsonnet +model.fieldConfig.defaults.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +###### fn model.fieldConfig.defaults.withWriteable + +```jsonnet +model.fieldConfig.defaults.withWriteable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source can write a value to the path. Auth/authz are supported separately +###### obj model.fieldConfig.defaults.color + + +####### fn model.fieldConfig.defaults.color.withFixedColor + +```jsonnet +model.fieldConfig.defaults.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +####### fn model.fieldConfig.defaults.color.withMode + +```jsonnet +model.fieldConfig.defaults.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +####### fn model.fieldConfig.defaults.color.withSeriesBy + +```jsonnet +model.fieldConfig.defaults.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +###### obj model.fieldConfig.defaults.mappings + + +####### obj model.fieldConfig.defaults.mappings.RangeMap + + +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RangeMap.options + + +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withFrom + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withTo + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +######### obj model.fieldConfig.defaults.mappings.RangeMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.RegexMap + + +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RegexMap.options + + +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withPattern + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.RegexMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.SpecialValueMap + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.SpecialValueMap.options + + +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.SpecialValueMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.ValueMap + + +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withType() +``` + + + +###### obj model.fieldConfig.defaults.thresholds + + +####### fn model.fieldConfig.defaults.thresholds.withMode + +```jsonnet +model.fieldConfig.defaults.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +####### fn model.fieldConfig.defaults.thresholds.withSteps + +```jsonnet +model.fieldConfig.defaults.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +####### fn model.fieldConfig.defaults.thresholds.withStepsMixin + +```jsonnet +model.fieldConfig.defaults.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md new file mode 100644 index 0000000..79d0a17 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md @@ -0,0 +1,34 @@ +# steps + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md new file mode 100644 index 0000000..35b01d5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/index.md @@ -0,0 +1,104 @@ +# overrides + + + +## Subpackages + +* [properties](properties.md) + +## Index + +* [`fn withMatcher(value)`](#fn-withmatcher) +* [`fn withMatcherMixin(value)`](#fn-withmatchermixin) +* [`fn withProperties(value)`](#fn-withproperties) +* [`fn withPropertiesMixin(value)`](#fn-withpropertiesmixin) +* [`obj matcher`](#obj-matcher) + * [`fn withId(value="")`](#fn-matcherwithid) + * [`fn withOptions(value)`](#fn-matcherwithoptions) + * [`fn withOptionsMixin(value)`](#fn-matcherwithoptionsmixin) + +## Fields + +### fn withMatcher + +```jsonnet +withMatcher(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withMatcherMixin + +```jsonnet +withMatcherMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withProperties + +```jsonnet +withProperties(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPropertiesMixin + +```jsonnet +withPropertiesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj matcher + + +#### fn matcher.withId + +```jsonnet +matcher.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn matcher.withOptions + +```jsonnet +matcher.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn matcher.withOptionsMixin + +```jsonnet +matcher.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md new file mode 100644 index 0000000..766e198 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/fieldConfig/overrides/properties.md @@ -0,0 +1,45 @@ +# properties + + + +## Index + +* [`fn withId(value="")`](#fn-withid) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) + +## Fields + +### fn withId + +```jsonnet +withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md new file mode 100644 index 0000000..fcc060a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md new file mode 100644 index 0000000..df55608 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/librarypanel/model/transformations.md @@ -0,0 +1,140 @@ +# transformations + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md new file mode 100644 index 0000000..0061f5a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/index.md @@ -0,0 +1,1215 @@ +# alertList + +grafonnet.panel.alertList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) + * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) + * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) + * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) + * [`obj AlertListOptions`](#obj-optionsalertlistoptions) + * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) + * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) + * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) + * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) + * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) + * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) + * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) + * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) + * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) + * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) + * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) + * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) + * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) + * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) + * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) + * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) + * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) + * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) + * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) + * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) + * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) + * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) + * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) + * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) + * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) + * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) + * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) + * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) + * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) + * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) + * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) + * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) + * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) + * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) + * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) + * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) + * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new alertlist panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlertListOptions + +```jsonnet +options.withAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withAlertListOptionsMixin + +```jsonnet +options.withAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptions + +```jsonnet +options.withUnifiedAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptionsMixin + +```jsonnet +options.withUnifiedAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.AlertListOptions + + +##### fn options.AlertListOptions.withAlertName + +```jsonnet +options.AlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withDashboardAlerts + +```jsonnet +options.AlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.AlertListOptions.withDashboardTitle + +```jsonnet +options.AlertListOptions.withDashboardTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withFolderId + +```jsonnet +options.AlertListOptions.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withMaxItems + +```jsonnet +options.AlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withShowOptions + +```jsonnet +options.AlertListOptions.withShowOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"current"`, `"changes"` + + +##### fn options.AlertListOptions.withSortOrder + +```jsonnet +options.AlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.AlertListOptions.withStateFilter + +```jsonnet +options.AlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withStateFilterMixin + +```jsonnet +options.AlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withTags + +```jsonnet +options.AlertListOptions.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.AlertListOptions.withTagsMixin + +```jsonnet +options.AlertListOptions.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### obj options.AlertListOptions.stateFilter + + +###### fn options.AlertListOptions.stateFilter.withAlerting + +```jsonnet +options.AlertListOptions.stateFilter.withAlerting(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withExecutionError + +```jsonnet +options.AlertListOptions.stateFilter.withExecutionError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withNoData + +```jsonnet +options.AlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withOk + +```jsonnet +options.AlertListOptions.stateFilter.withOk(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPaused + +```jsonnet +options.AlertListOptions.stateFilter.withPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPending + +```jsonnet +options.AlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.UnifiedAlertListOptions + + +##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter + +```jsonnet +options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withAlertName + +```jsonnet +options.UnifiedAlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withDashboardAlerts + +```jsonnet +options.UnifiedAlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withDatasource + +```jsonnet +options.UnifiedAlertListOptions.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withFolder + +```jsonnet +options.UnifiedAlertListOptions.withFolder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withFolderMixin + +```jsonnet +options.UnifiedAlertListOptions.withFolderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withGroupBy + +```jsonnet +options.UnifiedAlertListOptions.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupByMixin + +```jsonnet +options.UnifiedAlertListOptions.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupMode + +```jsonnet +options.UnifiedAlertListOptions.withGroupMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"default"`, `"custom"` + + +##### fn options.UnifiedAlertListOptions.withMaxItems + +```jsonnet +options.UnifiedAlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.UnifiedAlertListOptions.withShowInstances + +```jsonnet +options.UnifiedAlertListOptions.withShowInstances(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withSortOrder + +```jsonnet +options.UnifiedAlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.UnifiedAlertListOptions.withStateFilter + +```jsonnet +options.UnifiedAlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withStateFilterMixin + +```jsonnet +options.UnifiedAlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withViewMode + +```jsonnet +options.UnifiedAlertListOptions.withViewMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"stat"` + + +##### obj options.UnifiedAlertListOptions.folder + + +###### fn options.UnifiedAlertListOptions.folder.withId + +```jsonnet +options.UnifiedAlertListOptions.folder.withId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.UnifiedAlertListOptions.folder.withTitle + +```jsonnet +options.UnifiedAlertListOptions.folder.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.UnifiedAlertListOptions.stateFilter + + +###### fn options.UnifiedAlertListOptions.stateFilter.withError + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withFiring + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withInactive + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNoData + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNormal + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withPending + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/alertList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md new file mode 100644 index 0000000..0cd1707 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/index.md @@ -0,0 +1,788 @@ +# annotationsList + +grafonnet.panel.annotationsList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLimit(value=10)`](#fn-optionswithlimit) + * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) + * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) + * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) + * [`fn withOnlyFromThisDashboard(value=true)`](#fn-optionswithonlyfromthisdashboard) + * [`fn withOnlyInTimeRange(value=true)`](#fn-optionswithonlyintimerange) + * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new annotationsList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLimit + +```jsonnet +options.withLimit(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withNavigateAfter + +```jsonnet +options.withNavigateAfter(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateBefore + +```jsonnet +options.withNavigateBefore(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateToPanel + +```jsonnet +options.withNavigateToPanel(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyFromThisDashboard + +```jsonnet +options.withOnlyFromThisDashboard(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyInTimeRange + +```jsonnet +options.withOnlyInTimeRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTags + +```jsonnet +options.withShowTags(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowUser + +```jsonnet +options.withShowUser(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/annotationsList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md new file mode 100644 index 0000000..14ccb54 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/index.md @@ -0,0 +1,1426 @@ +# barChart + +grafonnet.panel.barChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) + * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) + * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) + * [`fn withFullHighlight(value=true)`](#fn-optionswithfullhighlight) + * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withStacking(value)`](#fn-optionswithstacking) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) + * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) + * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBarRadius + +```jsonnet +options.withBarRadius(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Controls the radius of each bar. +#### fn options.withBarWidth + +```jsonnet +options.withBarWidth(value=0.97) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.97` + +Controls the width of bars. 1 = Max width, 0 = Min width. +#### fn options.withColorByField + +```jsonnet +options.withColorByField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use the color value for a sibling field to color each bar value. +#### fn options.withFullHighlight + +```jsonnet +options.withFullHighlight(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enables mode which highlights the entire bar area and shows tooltip when cursor +hovers over highlighted area +#### fn options.withGroupWidth + +```jsonnet +options.withGroupWidth(value=0.7) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.7` + +Controls the width of groups. 1 = max with, 0 = min width. +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withStacking + +```jsonnet +options.withStacking(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Manually select which field from the dataset to represent the x field. +#### fn options.withXTickLabelMaxLength + +```jsonnet +options.withXTickLabelMaxLength(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the max length that a label can have before it is truncated. +#### fn options.withXTickLabelRotation + +```jsonnet +options.withXTickLabelRotation(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the rotation of the x axis labels. +#### fn options.withXTickLabelSpacing + +```jsonnet +options.withXTickLabelSpacing(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the spacing between x axis labels. +negative values indicate backwards skipping behavior +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md new file mode 100644 index 0000000..033c65a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/index.md @@ -0,0 +1,906 @@ +# barGauge + +grafonnet.panel.barGauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayMode(value)`](#fn-optionswithdisplaymode) + * [`fn withMaxVizHeight(value=300)`](#fn-optionswithmaxvizheight) + * [`fn withMinVizHeight(value=16)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=8)`](#fn-optionswithminvizwidth) + * [`fn withNamePlacement(value)`](#fn-optionswithnameplacement) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) + * [`fn withSizing(value)`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withValueMode(value)`](#fn-optionswithvaluemode) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barGauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayMode + +```jsonnet +options.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +#### fn options.withMaxVizHeight + +```jsonnet +options.withMaxVizHeight(value=300) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `300` + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=16) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `16` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=8) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `8` + + +#### fn options.withNamePlacement + +```jsonnet +options.withNamePlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"left"` + +Allows for the bar gauge name to be placed explicitly +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowUnfilled + +```jsonnet +options.withShowUnfilled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withValueMode + +```jsonnet +options.withValueMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/barGauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md new file mode 100644 index 0000000..b20031e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/index.md @@ -0,0 +1,1755 @@ +# candlestick + +grafonnet.panel.candlestick + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCandleStyle(value)`](#fn-optionswithcandlestyle) + * [`fn withColorStrategy(value)`](#fn-optionswithcolorstrategy) + * [`fn withColors(value)`](#fn-optionswithcolors) + * [`fn withColorsMixin(value)`](#fn-optionswithcolorsmixin) + * [`fn withFields(value)`](#fn-optionswithfields) + * [`fn withFieldsMixin(value)`](#fn-optionswithfieldsmixin) + * [`fn withIncludeAllFields(value=true)`](#fn-optionswithincludeallfields) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj colors`](#obj-optionscolors) + * [`fn withDown(value="red")`](#fn-optionscolorswithdown) + * [`fn withFlat(value="gray")`](#fn-optionscolorswithflat) + * [`fn withUp(value="green")`](#fn-optionscolorswithup) + * [`obj fields`](#obj-optionsfields) + * [`fn withClose(value)`](#fn-optionsfieldswithclose) + * [`fn withHigh(value)`](#fn-optionsfieldswithhigh) + * [`fn withLow(value)`](#fn-optionsfieldswithlow) + * [`fn withOpen(value)`](#fn-optionsfieldswithopen) + * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new candlestick panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCandleStyle + +```jsonnet +options.withCandleStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"candles"`, `"ohlcbars"` + + +#### fn options.withColorStrategy + +```jsonnet +options.withColorStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"open-close"`, `"close-close"` + + +#### fn options.withColors + +```jsonnet +options.withColors(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withColorsMixin + +```jsonnet +options.withColorsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withFields + +```jsonnet +options.withFields(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withFieldsMixin + +```jsonnet +options.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withIncludeAllFields + +```jsonnet +options.withIncludeAllFields(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled, all fields will be sent to the graph +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"candles+volume"`, `"candles"`, `"volume"` + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.colors + + +##### fn options.colors.withDown + +```jsonnet +options.colors.withDown(value="red") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"red"` + + +##### fn options.colors.withFlat + +```jsonnet +options.colors.withFlat(value="gray") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"gray"` + + +##### fn options.colors.withUp + +```jsonnet +options.colors.withUp(value="green") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"green"` + + +#### obj options.fields + + +##### fn options.fields.withClose + +```jsonnet +options.fields.withClose(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the final (end) value of the given period +##### fn options.fields.withHigh + +```jsonnet +options.fields.withHigh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the highest value of the given period +##### fn options.fields.withLow + +```jsonnet +options.fields.withLow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the lowest value of the given period +##### fn options.fields.withOpen + +```jsonnet +options.fields.withOpen(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the starting value of the given period +##### fn options.fields.withVolume + +```jsonnet +options.fields.withVolume(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the sample count in the given period. (e.g. number of trades) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/candlestick/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md new file mode 100644 index 0000000..3fa434f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/index.md @@ -0,0 +1,775 @@ +# canvas + +grafonnet.panel.canvas + +## Subpackages + +* [options.root.elements](options/root/elements/index.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withInfinitePan(value=true)`](#fn-optionswithinfinitepan) + * [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting) + * [`fn withPanZoom(value=true)`](#fn-optionswithpanzoom) + * [`fn withRoot(value)`](#fn-optionswithroot) + * [`fn withRootMixin(value)`](#fn-optionswithrootmixin) + * [`fn withShowAdvancedTypes(value=true)`](#fn-optionswithshowadvancedtypes) + * [`obj root`](#obj-optionsroot) + * [`fn withElements(value)`](#fn-optionsrootwithelements) + * [`fn withElementsMixin(value)`](#fn-optionsrootwithelementsmixin) + * [`fn withName(value)`](#fn-optionsrootwithname) + * [`fn withType()`](#fn-optionsrootwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new canvas panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withInfinitePan + +```jsonnet +options.withInfinitePan(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable infinite pan +#### fn options.withInlineEditing + +```jsonnet +options.withInlineEditing(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable inline editing +#### fn options.withPanZoom + +```jsonnet +options.withPanZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable pan and zoom +#### fn options.withRoot + +```jsonnet +options.withRoot(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withRootMixin + +```jsonnet +options.withRootMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withShowAdvancedTypes + +```jsonnet +options.withShowAdvancedTypes(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show all available element types +#### obj options.root + + +##### fn options.root.withElements + +```jsonnet +options.root.withElements(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withElementsMixin + +```jsonnet +options.root.withElementsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withName + +```jsonnet +options.root.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the root element +##### fn options.root.withType + +```jsonnet +options.root.withType() +``` + + +Type of root element (frame) +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md new file mode 100644 index 0000000..f157158 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/index.md @@ -0,0 +1,410 @@ +# connections + + + +## Subpackages + +* [vertices](vertices.md) + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withColorMixin(value)`](#fn-withcolormixin) +* [`fn withPath(value)`](#fn-withpath) +* [`fn withSize(value)`](#fn-withsize) +* [`fn withSizeMixin(value)`](#fn-withsizemixin) +* [`fn withSource(value)`](#fn-withsource) +* [`fn withSourceMixin(value)`](#fn-withsourcemixin) +* [`fn withSourceOriginal(value)`](#fn-withsourceoriginal) +* [`fn withSourceOriginalMixin(value)`](#fn-withsourceoriginalmixin) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withTargetName(value)`](#fn-withtargetname) +* [`fn withTargetOriginal(value)`](#fn-withtargetoriginal) +* [`fn withTargetOriginalMixin(value)`](#fn-withtargetoriginalmixin) +* [`fn withVertices(value)`](#fn-withvertices) +* [`fn withVerticesMixin(value)`](#fn-withverticesmixin) +* [`obj color`](#obj-color) + * [`fn withField(value)`](#fn-colorwithfield) + * [`fn withFixed(value)`](#fn-colorwithfixed) +* [`obj size`](#obj-size) + * [`fn withField(value)`](#fn-sizewithfield) + * [`fn withFixed(value)`](#fn-sizewithfixed) + * [`fn withMax(value)`](#fn-sizewithmax) + * [`fn withMin(value)`](#fn-sizewithmin) + * [`fn withMode(value)`](#fn-sizewithmode) +* [`obj source`](#obj-source) + * [`fn withX(value)`](#fn-sourcewithx) + * [`fn withY(value)`](#fn-sourcewithy) +* [`obj sourceOriginal`](#obj-sourceoriginal) + * [`fn withX(value)`](#fn-sourceoriginalwithx) + * [`fn withY(value)`](#fn-sourceoriginalwithy) +* [`obj target`](#obj-target) + * [`fn withX(value)`](#fn-targetwithx) + * [`fn withY(value)`](#fn-targetwithy) +* [`obj targetOriginal`](#obj-targetoriginal) + * [`fn withX(value)`](#fn-targetoriginalwithx) + * [`fn withY(value)`](#fn-targetoriginalwithy) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withColorMixin + +```jsonnet +withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPath + +```jsonnet +withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"straight"` + + +### fn withSize + +```jsonnet +withSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSizeMixin + +```jsonnet +withSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSource + +```jsonnet +withSource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceMixin + +```jsonnet +withSourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginal + +```jsonnet +withSourceOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginalMixin + +```jsonnet +withSourceOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetName + +```jsonnet +withTargetName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTargetOriginal + +```jsonnet +withTargetOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetOriginalMixin + +```jsonnet +withTargetOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withVertices + +```jsonnet +withVertices(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withVerticesMixin + +```jsonnet +withVerticesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj color + + +#### fn color.withField + +```jsonnet +color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn color.withFixed + +```jsonnet +color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj size + + +#### fn size.withField + +```jsonnet +size.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn size.withFixed + +```jsonnet +size.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMax + +```jsonnet +size.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMin + +```jsonnet +size.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMode + +```jsonnet +size.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj source + + +#### fn source.withX + +```jsonnet +source.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn source.withY + +```jsonnet +source.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj sourceOriginal + + +#### fn sourceOriginal.withX + +```jsonnet +sourceOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn sourceOriginal.withY + +```jsonnet +sourceOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj target + + +#### fn target.withX + +```jsonnet +target.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn target.withY + +```jsonnet +target.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj targetOriginal + + +#### fn targetOriginal.withX + +```jsonnet +targetOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn targetOriginal.withY + +```jsonnet +targetOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md new file mode 100644 index 0000000..70f44a3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/connections/vertices.md @@ -0,0 +1,32 @@ +# vertices + + + +## Index + +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) + +## Fields + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md new file mode 100644 index 0000000..73f5b6e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/options/root/elements/index.md @@ -0,0 +1,512 @@ +# elements + + + +## Subpackages + +* [connections](connections/index.md) + +## Index + +* [`fn withBackground(value)`](#fn-withbackground) +* [`fn withBackgroundMixin(value)`](#fn-withbackgroundmixin) +* [`fn withBorder(value)`](#fn-withborder) +* [`fn withBorderMixin(value)`](#fn-withbordermixin) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withConnections(value)`](#fn-withconnections) +* [`fn withConnectionsMixin(value)`](#fn-withconnectionsmixin) +* [`fn withConstraint(value)`](#fn-withconstraint) +* [`fn withConstraintMixin(value)`](#fn-withconstraintmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withPlacement(value)`](#fn-withplacement) +* [`fn withPlacementMixin(value)`](#fn-withplacementmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj background`](#obj-background) + * [`fn withColor(value)`](#fn-backgroundwithcolor) + * [`fn withColorMixin(value)`](#fn-backgroundwithcolormixin) + * [`fn withImage(value)`](#fn-backgroundwithimage) + * [`fn withImageMixin(value)`](#fn-backgroundwithimagemixin) + * [`fn withSize(value)`](#fn-backgroundwithsize) + * [`obj color`](#obj-backgroundcolor) + * [`fn withField(value)`](#fn-backgroundcolorwithfield) + * [`fn withFixed(value)`](#fn-backgroundcolorwithfixed) + * [`obj image`](#obj-backgroundimage) + * [`fn withField(value)`](#fn-backgroundimagewithfield) + * [`fn withFixed(value)`](#fn-backgroundimagewithfixed) + * [`fn withMode(value)`](#fn-backgroundimagewithmode) +* [`obj border`](#obj-border) + * [`fn withColor(value)`](#fn-borderwithcolor) + * [`fn withColorMixin(value)`](#fn-borderwithcolormixin) + * [`fn withRadius(value)`](#fn-borderwithradius) + * [`fn withWidth(value)`](#fn-borderwithwidth) + * [`obj color`](#obj-bordercolor) + * [`fn withField(value)`](#fn-bordercolorwithfield) + * [`fn withFixed(value)`](#fn-bordercolorwithfixed) +* [`obj constraint`](#obj-constraint) + * [`fn withHorizontal(value)`](#fn-constraintwithhorizontal) + * [`fn withVertical(value)`](#fn-constraintwithvertical) +* [`obj placement`](#obj-placement) + * [`fn withBottom(value)`](#fn-placementwithbottom) + * [`fn withHeight(value)`](#fn-placementwithheight) + * [`fn withLeft(value)`](#fn-placementwithleft) + * [`fn withRight(value)`](#fn-placementwithright) + * [`fn withRotation(value)`](#fn-placementwithrotation) + * [`fn withTop(value)`](#fn-placementwithtop) + * [`fn withWidth(value)`](#fn-placementwithwidth) + +## Fields + +### fn withBackground + +```jsonnet +withBackground(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBackgroundMixin + +```jsonnet +withBackgroundMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorder + +```jsonnet +withBorder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorderMixin + +```jsonnet +withBorderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConnections + +```jsonnet +withConnections(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConnectionsMixin + +```jsonnet +withConnectionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConstraint + +```jsonnet +withConstraint(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConstraintMixin + +```jsonnet +withConstraintMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPlacement + +```jsonnet +withPlacement(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPlacementMixin + +```jsonnet +withPlacementMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj background + + +#### fn background.withColor + +```jsonnet +background.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withColorMixin + +```jsonnet +background.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withImage + +```jsonnet +background.withImage(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withImageMixin + +```jsonnet +background.withImageMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withSize + +```jsonnet +background.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"original"`, `"contain"`, `"cover"`, `"fill"`, `"tile"` + + +#### obj background.color + + +##### fn background.color.withField + +```jsonnet +background.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.color.withFixed + +```jsonnet +background.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +#### obj background.image + + +##### fn background.image.withField + +```jsonnet +background.image.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.image.withFixed + +```jsonnet +background.image.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn background.image.withMode + +```jsonnet +background.image.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"mapping"` + + +### obj border + + +#### fn border.withColor + +```jsonnet +border.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withColorMixin + +```jsonnet +border.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withRadius + +```jsonnet +border.withRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn border.withWidth + +```jsonnet +border.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj border.color + + +##### fn border.color.withField + +```jsonnet +border.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn border.color.withFixed + +```jsonnet +border.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj constraint + + +#### fn constraint.withHorizontal + +```jsonnet +constraint.withHorizontal(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"left"`, `"right"`, `"leftright"`, `"center"`, `"scale"` + + +#### fn constraint.withVertical + +```jsonnet +constraint.withVertical(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"top"`, `"bottom"`, `"topbottom"`, `"center"`, `"scale"` + + +### obj placement + + +#### fn placement.withBottom + +```jsonnet +placement.withBottom(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withHeight + +```jsonnet +placement.withHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withLeft + +```jsonnet +placement.withLeft(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRight + +```jsonnet +placement.withRight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRotation + +```jsonnet +placement.withRotation(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withTop + +```jsonnet +placement.withTop(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withWidth + +```jsonnet +placement.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/canvas/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md new file mode 100644 index 0000000..1f92a98 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/index.md @@ -0,0 +1,799 @@ +# dashboardList + +grafonnet.panel.dashboardList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFolderId(value)`](#fn-optionswithfolderid) + * [`fn withFolderUID(value)`](#fn-optionswithfolderuid) + * [`fn withIncludeVars(value=true)`](#fn-optionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) + * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) + * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) + * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) + * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) + * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboardList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFolderId + +```jsonnet +options.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +folderId is deprecated, and migrated to folderUid on panel init +#### fn options.withFolderUID + +```jsonnet +options.withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn options.withIncludeVars + +```jsonnet +options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withKeepTime + +```jsonnet +options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withMaxItems + +```jsonnet +options.withMaxItems(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withQuery + +```jsonnet +options.withQuery(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +#### fn options.withShowHeadings + +```jsonnet +options.withShowHeadings(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowRecentlyViewed + +```jsonnet +options.withShowRecentlyViewed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowSearch + +```jsonnet +options.withShowSearch(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowStarred + +```jsonnet +options.withShowStarred(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/dashboardList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md new file mode 100644 index 0000000..a8832f7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/index.md @@ -0,0 +1,660 @@ +# datagrid + +grafonnet.panel.datagrid + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new datagrid panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withSelectedSeries + +```jsonnet +options.withSelectedSeries(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/datagrid/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/index.md new file mode 100644 index 0000000..3eb99e1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/index.md @@ -0,0 +1,727 @@ +# debug + +grafonnet.panel.debug + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCounters(value)`](#fn-optionswithcounters) + * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj counters`](#obj-optionscounters) + * [`fn withDataChanged(value=true)`](#fn-optionscounterswithdatachanged) + * [`fn withRender(value=true)`](#fn-optionscounterswithrender) + * [`fn withSchemaChanged(value=true)`](#fn-optionscounterswithschemachanged) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new debug panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCounters + +```jsonnet +options.withCounters(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCountersMixin + +```jsonnet +options.withCountersMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"render"`, `"events"`, `"cursor"`, `"State"`, `"ThrowError"` + + +#### obj options.counters + + +##### fn options.counters.withDataChanged + +```jsonnet +options.counters.withDataChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withRender + +```jsonnet +options.counters.withRender(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withSchemaChanged + +```jsonnet +options.counters.withSchemaChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/debug/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md new file mode 100644 index 0000000..50d4a44 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/index.md @@ -0,0 +1,866 @@ +# gauge + +grafonnet.panel.gauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withMinVizHeight(value=75)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=75)`](#fn-optionswithminvizwidth) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowThresholdLabels(value=true)`](#fn-optionswithshowthresholdlabels) + * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) + * [`fn withSizing(value)`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new gauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowThresholdLabels + +```jsonnet +options.withShowThresholdLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowThresholdMarkers + +```jsonnet +options.withShowThresholdMarkers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/gauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md new file mode 100644 index 0000000..0d8bb8c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/index.md @@ -0,0 +1,1226 @@ +# geomap + +grafonnet.panel.geomap + +## Subpackages + +* [options.layers](options/layers.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBasemap(value)`](#fn-optionswithbasemap) + * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) + * [`fn withControls(value)`](#fn-optionswithcontrols) + * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) + * [`fn withLayers(value)`](#fn-optionswithlayers) + * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withView(value)`](#fn-optionswithview) + * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) + * [`obj basemap`](#obj-optionsbasemap) + * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) + * [`fn withConfigMixin(value)`](#fn-optionsbasemapwithconfigmixin) + * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) + * [`fn withFilterDataMixin(value)`](#fn-optionsbasemapwithfilterdatamixin) + * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) + * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) + * [`fn withName(value)`](#fn-optionsbasemapwithname) + * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) + * [`fn withTooltip(value=true)`](#fn-optionsbasemapwithtooltip) + * [`fn withType(value)`](#fn-optionsbasemapwithtype) + * [`obj location`](#obj-optionsbasemaplocation) + * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) + * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) + * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) + * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) + * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) + * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) + * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) + * [`obj controls`](#obj-optionscontrols) + * [`fn withMouseWheelZoom(value=true)`](#fn-optionscontrolswithmousewheelzoom) + * [`fn withShowAttribution(value=true)`](#fn-optionscontrolswithshowattribution) + * [`fn withShowDebug(value=true)`](#fn-optionscontrolswithshowdebug) + * [`fn withShowMeasure(value=true)`](#fn-optionscontrolswithshowmeasure) + * [`fn withShowScale(value=true)`](#fn-optionscontrolswithshowscale) + * [`fn withShowZoom(value=true)`](#fn-optionscontrolswithshowzoom) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`obj view`](#obj-optionsview) + * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) + * [`fn withId(value="zero")`](#fn-optionsviewwithid) + * [`fn withLastOnly(value=true)`](#fn-optionsviewwithlastonly) + * [`fn withLat(value=0)`](#fn-optionsviewwithlat) + * [`fn withLayer(value)`](#fn-optionsviewwithlayer) + * [`fn withLon(value=0)`](#fn-optionsviewwithlon) + * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) + * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) + * [`fn withPadding(value)`](#fn-optionsviewwithpadding) + * [`fn withShared(value=true)`](#fn-optionsviewwithshared) + * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new geomap panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBasemap + +```jsonnet +options.withBasemap(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withBasemapMixin + +```jsonnet +options.withBasemapMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControls + +```jsonnet +options.withControls(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControlsMixin + +```jsonnet +options.withControlsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLayers + +```jsonnet +options.withLayers(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLayersMixin + +```jsonnet +options.withLayersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withView + +```jsonnet +options.withView(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withViewMixin + +```jsonnet +options.withViewMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.basemap + + +##### fn options.basemap.withConfig + +```jsonnet +options.basemap.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withConfigMixin + +```jsonnet +options.basemap.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withFilterData + +```jsonnet +options.basemap.withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withFilterDataMixin + +```jsonnet +options.basemap.withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withLocation + +```jsonnet +options.basemap.withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withLocationMixin + +```jsonnet +options.basemap.withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.basemap.withName + +```jsonnet +options.basemap.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +##### fn options.basemap.withOpacity + +```jsonnet +options.basemap.withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +##### fn options.basemap.withTooltip + +```jsonnet +options.basemap.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +##### fn options.basemap.withType + +```jsonnet +options.basemap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.basemap.location + + +###### fn options.basemap.location.withGazetteer + +```jsonnet +options.basemap.location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +###### fn options.basemap.location.withGeohash + +```jsonnet +options.basemap.location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +###### fn options.basemap.location.withLatitude + +```jsonnet +options.basemap.location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLongitude + +```jsonnet +options.basemap.location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLookup + +```jsonnet +options.basemap.location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withMode + +```jsonnet +options.basemap.location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +###### fn options.basemap.location.withWkt + +```jsonnet +options.basemap.location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.controls + + +##### fn options.controls.withMouseWheelZoom + +```jsonnet +options.controls.withMouseWheelZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +let the mouse wheel zoom +##### fn options.controls.withShowAttribution + +```jsonnet +options.controls.withShowAttribution(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Lower right +##### fn options.controls.withShowDebug + +```jsonnet +options.controls.withShowDebug(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show debug +##### fn options.controls.withShowMeasure + +```jsonnet +options.controls.withShowMeasure(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show measure +##### fn options.controls.withShowScale + +```jsonnet +options.controls.withShowScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Scale options +##### fn options.controls.withShowZoom + +```jsonnet +options.controls.withShowZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Zoom (upper left) +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"details"` + + +#### obj options.view + + +##### fn options.view.withAllLayers + +```jsonnet +options.view.withAllLayers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withId + +```jsonnet +options.view.withId(value="zero") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"zero"` + + +##### fn options.view.withLastOnly + +```jsonnet +options.view.withLastOnly(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withLat + +```jsonnet +options.view.withLat(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withLayer + +```jsonnet +options.view.withLayer(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.view.withLon + +```jsonnet +options.view.withLon(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withMaxZoom + +```jsonnet +options.view.withMaxZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withMinZoom + +```jsonnet +options.view.withMinZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withPadding + +```jsonnet +options.view.withPadding(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withShared + +```jsonnet +options.view.withShared(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withZoom + +```jsonnet +options.view.withZoom(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md new file mode 100644 index 0000000..cf4881d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/options/layers.md @@ -0,0 +1,220 @@ +# layers + + + +## Index + +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withFilterData(value)`](#fn-withfilterdata) +* [`fn withFilterDataMixin(value)`](#fn-withfilterdatamixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withLocationMixin(value)`](#fn-withlocationmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOpacity(value)`](#fn-withopacity) +* [`fn withTooltip(value=true)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`obj location`](#obj-location) + * [`fn withGazetteer(value)`](#fn-locationwithgazetteer) + * [`fn withGeohash(value)`](#fn-locationwithgeohash) + * [`fn withLatitude(value)`](#fn-locationwithlatitude) + * [`fn withLongitude(value)`](#fn-locationwithlongitude) + * [`fn withLookup(value)`](#fn-locationwithlookup) + * [`fn withMode(value)`](#fn-locationwithmode) + * [`fn withWkt(value)`](#fn-locationwithwkt) + +## Fields + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withFilterData + +```jsonnet +withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withFilterDataMixin + +```jsonnet +withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLocationMixin + +```jsonnet +withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +### fn withOpacity + +```jsonnet +withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +### fn withTooltip + +```jsonnet +withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj location + + +#### fn location.withGazetteer + +```jsonnet +location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +#### fn location.withGeohash + +```jsonnet +location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +#### fn location.withLatitude + +```jsonnet +location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLongitude + +```jsonnet +location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLookup + +```jsonnet +location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withMode + +```jsonnet +location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +#### fn location.withWkt + +```jsonnet +location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/geomap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md new file mode 100644 index 0000000..7d0f3e6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/index.md @@ -0,0 +1,1841 @@ +# heatmap + +grafonnet.panel.heatmap + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCalculate(value=true)`](#fn-optionswithcalculate) + * [`fn withCalculation(value)`](#fn-optionswithcalculation) + * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) + * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) + * [`fn withCellRadius(value)`](#fn-optionswithcellradius) + * [`fn withCellValues(value)`](#fn-optionswithcellvalues) + * [`fn withCellValuesMixin(value)`](#fn-optionswithcellvaluesmixin) + * [`fn withColor(value)`](#fn-optionswithcolor) + * [`fn withColorMixin(value)`](#fn-optionswithcolormixin) + * [`fn withExemplars(value)`](#fn-optionswithexemplars) + * [`fn withExemplarsMixin(value)`](#fn-optionswithexemplarsmixin) + * [`fn withFilterValues(value)`](#fn-optionswithfiltervalues) + * [`fn withFilterValuesMixin(value)`](#fn-optionswithfiltervaluesmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) + * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withYAxis(value)`](#fn-optionswithyaxis) + * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) + * [`obj calculation`](#obj-optionscalculation) + * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) + * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) + * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) + * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) + * [`obj xBuckets`](#obj-optionscalculationxbuckets) + * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) + * [`obj scale`](#obj-optionscalculationxbucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) + * [`obj yBuckets`](#obj-optionscalculationybuckets) + * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) + * [`obj scale`](#obj-optionscalculationybucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) + * [`obj cellValues`](#obj-optionscellvalues) + * [`fn withDecimals(value)`](#fn-optionscellvalueswithdecimals) + * [`fn withUnit(value)`](#fn-optionscellvalueswithunit) + * [`obj color`](#obj-optionscolor) + * [`fn withExponent(value)`](#fn-optionscolorwithexponent) + * [`fn withFill(value)`](#fn-optionscolorwithfill) + * [`fn withMax(value)`](#fn-optionscolorwithmax) + * [`fn withMin(value)`](#fn-optionscolorwithmin) + * [`fn withMode(value)`](#fn-optionscolorwithmode) + * [`fn withReverse(value=true)`](#fn-optionscolorwithreverse) + * [`fn withScale(value)`](#fn-optionscolorwithscale) + * [`fn withScheme(value)`](#fn-optionscolorwithscheme) + * [`fn withSteps(value)`](#fn-optionscolorwithsteps) + * [`obj exemplars`](#obj-optionsexemplars) + * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) + * [`obj filterValues`](#obj-optionsfiltervalues) + * [`fn withGe(value)`](#fn-optionsfiltervalueswithge) + * [`fn withLe(value)`](#fn-optionsfiltervalueswithle) + * [`obj legend`](#obj-optionslegend) + * [`fn withShow(value=true)`](#fn-optionslegendwithshow) + * [`obj rowsFrame`](#obj-optionsrowsframe) + * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) + * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withShowColorScale(value=true)`](#fn-optionstooltipwithshowcolorscale) + * [`fn withYHistogram(value=true)`](#fn-optionstooltipwithyhistogram) + * [`obj yAxis`](#obj-optionsyaxis) + * [`fn withAxisBorderShow(value=true)`](#fn-optionsyaxiswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-optionsyaxiswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-optionsyaxiswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) + * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) + * [`fn withMax(value)`](#fn-optionsyaxiswithmax) + * [`fn withMin(value)`](#fn-optionsyaxiswithmin) + * [`fn withReverse(value=true)`](#fn-optionsyaxiswithreverse) + * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) + * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) + * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) + * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new heatmap panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCalculate + +```jsonnet +options.withCalculate(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the heatmap should be calculated from data +#### fn options.withCalculation + +```jsonnet +options.withCalculation(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCalculationMixin + +```jsonnet +options.withCalculationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCellGap + +```jsonnet +options.withCellGap(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls gap between cells +#### fn options.withCellRadius + +```jsonnet +options.withCellRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls cell radius +#### fn options.withCellValues + +```jsonnet +options.withCellValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withCellValuesMixin + +```jsonnet +options.withCellValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withColor + +```jsonnet +options.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +#### fn options.withColorMixin + +```jsonnet +options.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls various color options +#### fn options.withExemplars + +```jsonnet +options.withExemplars(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withExemplarsMixin + +```jsonnet +options.withExemplarsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls exemplar options +#### fn options.withFilterValues + +```jsonnet +options.withFilterValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +#### fn options.withFilterValuesMixin + +```jsonnet +options.withFilterValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls the value filter range +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls legend options +#### fn options.withRowsFrame + +```jsonnet +options.withRowsFrame(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withRowsFrameMixin + +```jsonnet +options.withRowsFrameMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withYAxis + +```jsonnet +options.withYAxis(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### fn options.withYAxisMixin + +```jsonnet +options.withYAxisMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### obj options.calculation + + +##### fn options.calculation.withXBuckets + +```jsonnet +options.calculation.withXBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withXBucketsMixin + +```jsonnet +options.calculation.withXBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBuckets + +```jsonnet +options.calculation.withYBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.calculation.withYBucketsMixin + +```jsonnet +options.calculation.withYBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj options.calculation.xBuckets + + +###### fn options.calculation.xBuckets.withMode + +```jsonnet +options.calculation.xBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.xBuckets.withScale + +```jsonnet +options.calculation.xBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withScaleMixin + +```jsonnet +options.calculation.xBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withValue + +```jsonnet +options.calculation.xBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.xBuckets.scale + + +####### fn options.calculation.xBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.xBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withLog + +```jsonnet +options.calculation.xBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withType + +```jsonnet +options.calculation.xBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +##### obj options.calculation.yBuckets + + +###### fn options.calculation.yBuckets.withMode + +```jsonnet +options.calculation.yBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + + +###### fn options.calculation.yBuckets.withScale + +```jsonnet +options.calculation.yBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withScaleMixin + +```jsonnet +options.calculation.yBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withValue + +```jsonnet +options.calculation.yBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.yBuckets.scale + + +####### fn options.calculation.yBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.yBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withLog + +```jsonnet +options.calculation.yBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withType + +```jsonnet +options.calculation.yBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +#### obj options.cellValues + + +##### fn options.cellValues.withDecimals + +```jsonnet +options.cellValues.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for cell values +##### fn options.cellValues.withUnit + +```jsonnet +options.cellValues.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the cell value unit +#### obj options.color + + +##### fn options.color.withExponent + +```jsonnet +options.color.withExponent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the exponent when scale is set to exponential +##### fn options.color.withFill + +```jsonnet +options.color.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color fill when in opacity mode +##### fn options.color.withMax + +```jsonnet +options.color.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the color scale +##### fn options.color.withMin + +```jsonnet +options.color.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the color scale +##### fn options.color.withMode + +```jsonnet +options.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"opacity"`, `"scheme"` + +Controls the color mode of the heatmap +##### fn options.color.withReverse + +```jsonnet +options.color.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the color scheme +##### fn options.color.withScale + +```jsonnet +options.color.withScale(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"exponential"` + +Controls the color scale of the heatmap +##### fn options.color.withScheme + +```jsonnet +options.color.withScheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color scheme used +##### fn options.color.withSteps + +```jsonnet +options.color.withSteps(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Controls the number of color steps +#### obj options.exemplars + + +##### fn options.exemplars.withColor + +```jsonnet +options.exemplars.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the color of the exemplar markers +#### obj options.filterValues + + +##### fn options.filterValues.withGe + +```jsonnet +options.filterValues.withGe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values greater than or equal to the given value +##### fn options.filterValues.withLe + +```jsonnet +options.filterValues.withLe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values less than or equal to the given value +#### obj options.legend + + +##### fn options.legend.withShow + +```jsonnet +options.legend.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the legend is shown +#### obj options.rowsFrame + + +##### fn options.rowsFrame.withLayout + +```jsonnet +options.rowsFrame.withLayout(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"le"`, `"ge"`, `"unknown"`, `"auto"` + + +##### fn options.rowsFrame.withValue + +```jsonnet +options.rowsFrame.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the name of the cell when not calculating from data +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withShowColorScale + +```jsonnet +options.tooltip.withShowColorScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a color scale in header +##### fn options.tooltip.withYHistogram + +```jsonnet +options.tooltip.withYHistogram(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a histogram of the y-axis values +#### obj options.yAxis + + +##### fn options.yAxis.withAxisBorderShow + +```jsonnet +options.yAxis.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisCenteredZero + +```jsonnet +options.yAxis.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisColorMode + +```jsonnet +options.yAxis.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +##### fn options.yAxis.withAxisGridShow + +```jsonnet +options.yAxis.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisLabel + +```jsonnet +options.yAxis.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.yAxis.withAxisPlacement + +```jsonnet +options.yAxis.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +##### fn options.yAxis.withAxisSoftMax + +```jsonnet +options.yAxis.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisSoftMin + +```jsonnet +options.yAxis.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisWidth + +```jsonnet +options.yAxis.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withDecimals + +```jsonnet +options.yAxis.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for yAxis values +##### fn options.yAxis.withMax + +```jsonnet +options.yAxis.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the yAxis +##### fn options.yAxis.withMin + +```jsonnet +options.yAxis.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the yAxis +##### fn options.yAxis.withReverse + +```jsonnet +options.yAxis.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the yAxis +##### fn options.yAxis.withScaleDistribution + +```jsonnet +options.yAxis.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withScaleDistributionMixin + +```jsonnet +options.yAxis.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withUnit + +```jsonnet +options.yAxis.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the yAxis unit +##### obj options.yAxis.scaleDistribution + + +###### fn options.yAxis.scaleDistribution.withLinearThreshold + +```jsonnet +options.yAxis.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withLog + +```jsonnet +options.yAxis.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withType + +```jsonnet +options.yAxis.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/heatmap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md new file mode 100644 index 0000000..e09fae1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/index.md @@ -0,0 +1,1282 @@ +# histogram + +grafonnet.panel.histogram + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBucketCount(value=30)`](#fn-optionswithbucketcount) + * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) + * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) + * [`fn withCombine(value=true)`](#fn-optionswithcombine) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new histogram panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBucketCount + +```jsonnet +options.withBucketCount(value=30) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `30` + +Bucket count (approx) +#### fn options.withBucketOffset + +```jsonnet +options.withBucketOffset(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Offset buckets by this amount +#### fn options.withBucketSize + +```jsonnet +options.withBucketSize(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Size of each bucket +#### fn options.withCombine + +```jsonnet +options.withCombine(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Combines multiple series into a single histogram +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/histogram/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/index.md new file mode 100644 index 0000000..3111a61 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/index.md @@ -0,0 +1,32 @@ +# panel + +grafonnet.panel + +## Subpackages + +* [alertList](alertList/index.md) +* [annotationsList](annotationsList/index.md) +* [barChart](barChart/index.md) +* [barGauge](barGauge/index.md) +* [candlestick](candlestick/index.md) +* [canvas](canvas/index.md) +* [dashboardList](dashboardList/index.md) +* [datagrid](datagrid/index.md) +* [debug](debug/index.md) +* [gauge](gauge/index.md) +* [geomap](geomap/index.md) +* [heatmap](heatmap/index.md) +* [histogram](histogram/index.md) +* [logs](logs/index.md) +* [news](news/index.md) +* [nodeGraph](nodeGraph/index.md) +* [pieChart](pieChart/index.md) +* [row](row.md) +* [stat](stat/index.md) +* [stateTimeline](stateTimeline/index.md) +* [statusHistory](statusHistory/index.md) +* [table](table/index.md) +* [text](text/index.md) +* [timeSeries](timeSeries/index.md) +* [trend](trend/index.md) +* [xyChart](xyChart/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/index.md new file mode 100644 index 0000000..6f1f2d2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/index.md @@ -0,0 +1,764 @@ +# logs + +grafonnet.panel.logs + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) + * [`fn withEnableLogDetails(value=true)`](#fn-optionswithenablelogdetails) + * [`fn withPrettifyLogMessage(value=true)`](#fn-optionswithprettifylogmessage) + * [`fn withShowCommonLabels(value=true)`](#fn-optionswithshowcommonlabels) + * [`fn withShowLabels(value=true)`](#fn-optionswithshowlabels) + * [`fn withShowLogContextToggle(value=true)`](#fn-optionswithshowlogcontexttoggle) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withSortOrder(value)`](#fn-optionswithsortorder) + * [`fn withWrapLogMessage(value=true)`](#fn-optionswithwraplogmessage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new logs panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDedupStrategy + +```jsonnet +options.withDedupStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"exact"`, `"numbers"`, `"signature"` + + +#### fn options.withEnableLogDetails + +```jsonnet +options.withEnableLogDetails(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withPrettifyLogMessage + +```jsonnet +options.withPrettifyLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowCommonLabels + +```jsonnet +options.withShowCommonLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLabels + +```jsonnet +options.withShowLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLogContextToggle + +```jsonnet +options.withShowLogContextToggle(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSortOrder + +```jsonnet +options.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Descending"`, `"Ascending"` + + +#### fn options.withWrapLogMessage + +```jsonnet +options.withWrapLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/logs/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/index.md new file mode 100644 index 0000000..2cc7b47 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/index.md @@ -0,0 +1,672 @@ +# news + +grafonnet.panel.news + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) + * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new news panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFeedUrl + +```jsonnet +options.withFeedUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +empty/missing will default to grafana blog +#### fn options.withShowImage + +```jsonnet +options.withShowImage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/news/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md new file mode 100644 index 0000000..96e1eb6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/index.md @@ -0,0 +1,776 @@ +# nodeGraph + +grafonnet.panel.nodeGraph + +## Subpackages + +* [options.nodes.arcs](options/nodes/arcs.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withEdges(value)`](#fn-optionswithedges) + * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) + * [`fn withNodes(value)`](#fn-optionswithnodes) + * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) + * [`obj edges`](#obj-optionsedges) + * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) + * [`obj nodes`](#obj-optionsnodes) + * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) + * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) + * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new nodeGraph panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withEdges + +```jsonnet +options.withEdges(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withEdgesMixin + +```jsonnet +options.withEdgesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodes + +```jsonnet +options.withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodesMixin + +```jsonnet +options.withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.edges + + +##### fn options.edges.withMainStatUnit + +```jsonnet +options.edges.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.edges.withSecondaryStatUnit + +```jsonnet +options.edges.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +#### obj options.nodes + + +##### fn options.nodes.withArcs + +```jsonnet +options.nodes.withArcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withArcsMixin + +```jsonnet +options.nodes.withArcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withMainStatUnit + +```jsonnet +options.nodes.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.nodes.withSecondaryStatUnit + +```jsonnet +options.nodes.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md new file mode 100644 index 0000000..f80fe24 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/options/nodes/arcs.md @@ -0,0 +1,33 @@ +# arcs + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withField(value)`](#fn-withfield) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The color of the arc. +### fn withField + +```jsonnet +withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field from which to get the value. Values should be less than 1, representing fraction of a circle. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/nodeGraph/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md new file mode 100644 index 0000000..65d414c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/index.md @@ -0,0 +1,1174 @@ +# pieChart + +grafonnet.panel.pieChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) + * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withPieType(value)`](#fn-optionswithpietype) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withValues(value)`](#fn-optionslegendwithvalues) + * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new pieChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayLabels + +```jsonnet +options.withDisplayLabels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withDisplayLabelsMixin + +```jsonnet +options.withDisplayLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withPieType + +```jsonnet +options.withPieType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pie"`, `"donut"` + +Select the pie chart display style. +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withValues + +```jsonnet +options.legend.withValues(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withValuesMixin + +```jsonnet +options.legend.withValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/pieChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/row.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/row.md new file mode 100644 index 0000000..0541b04 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/row.md @@ -0,0 +1,179 @@ +# row + +grafonnet.panel.row + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withCollapsed(value=true)`](#fn-withcollapsed) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withGridPos(y)`](#fn-withgridpos) +* [`fn withGridPosMixin(value)`](#fn-withgridposmixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withPanels(value)`](#fn-withpanels) +* [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) +* [`fn withRepeat(value)`](#fn-withrepeat) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new row panel with a title. +### fn withCollapsed + +```jsonnet +withCollapsed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether this row should be collapsed or not. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withGridPos + +```jsonnet +withGridPos(y) +``` + +PARAMETERS: + +* **y** (`number`) + +`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values. +### fn withGridPosMixin + +```jsonnet +withGridPosMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Position and dimensions of a panel in the grid +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. +### fn withPanels + +```jsonnet +withPanels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeat + +```jsonnet +withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Row title +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/index.md new file mode 100644 index 0000000..71c9f64 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/index.md @@ -0,0 +1,879 @@ +# stat + +grafonnet.panel.stat + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColorMode(value)`](#fn-optionswithcolormode) + * [`fn withGraphMode(value)`](#fn-optionswithgraphmode) + * [`fn withJustifyMode(value)`](#fn-optionswithjustifymode) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowPercentChange(value=true)`](#fn-optionswithshowpercentchange) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTextMode(value)`](#fn-optionswithtextmode) + * [`fn withWideLayout(value=true)`](#fn-optionswithwidelayout) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stat panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColorMode + +```jsonnet +options.withColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"value"`, `"background"`, `"background_solid"`, `"none"` + +TODO docs +#### fn options.withGraphMode + +```jsonnet +options.withGraphMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"line"`, `"area"` + +TODO docs +#### fn options.withJustifyMode + +```jsonnet +options.withJustifyMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"center"` + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowPercentChange + +```jsonnet +options.withShowPercentChange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMode + +```jsonnet +options.withTextMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"value"`, `"value_and_name"`, `"name"`, `"none"` + +TODO docs +#### fn options.withWideLayout + +```jsonnet +options.withWideLayout(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stat/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md new file mode 100644 index 0000000..86dd843 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/index.md @@ -0,0 +1,1085 @@ +# stateTimeline + +grafonnet.panel.stateTimeline + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlignValue(value)`](#fn-optionswithalignvalue) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stateTimeline panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlignValue + +```jsonnet +options.withAlignValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"center"`, `"left"`, `"right"` + +Controls the value alignment in the TimelineChart component +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMergeValues + +```jsonnet +options.withMergeValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Merge equal consecutive values +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the row height +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/stateTimeline/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md new file mode 100644 index 0000000..e1ef08d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/index.md @@ -0,0 +1,1072 @@ +# statusHistory + +grafonnet.panel.statusHistory + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value)`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new statusHistory panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColWidth + +```jsonnet +options.withColWidth(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the column width +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Set the height of the rows +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/statusHistory/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/index.md new file mode 100644 index 0000000..4abb29f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/index.md @@ -0,0 +1,1981 @@ +# table + +grafonnet.panel.table + +## Subpackages + +* [options.sortBy](options/sortBy.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAlign(value)`](#fn-fieldconfigdefaultscustomwithalign) + * [`fn withCellOptions(value)`](#fn-fieldconfigdefaultscustomwithcelloptions) + * [`fn withCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomwithcelloptionsmixin) + * [`fn withDisplayMode(value)`](#fn-fieldconfigdefaultscustomwithdisplaymode) + * [`fn withFilterable(value=true)`](#fn-fieldconfigdefaultscustomwithfilterable) + * [`fn withHidden(value=true)`](#fn-fieldconfigdefaultscustomwithhidden) + * [`fn withHideHeader(value=true)`](#fn-fieldconfigdefaultscustomwithhideheader) + * [`fn withInspect(value=true)`](#fn-fieldconfigdefaultscustomwithinspect) + * [`fn withMinWidth(value)`](#fn-fieldconfigdefaultscustomwithminwidth) + * [`fn withWidth(value)`](#fn-fieldconfigdefaultscustomwithwidth) + * [`obj cellOptions`](#obj-fieldconfigdefaultscustomcelloptions) + * [`fn withTableAutoCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptions) + * [`fn withTableAutoCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptionsmixin) + * [`fn withTableBarGaugeCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptions) + * [`fn withTableBarGaugeCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptionsmixin) + * [`fn withTableColorTextCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptions) + * [`fn withTableColorTextCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptionsmixin) + * [`fn withTableColoredBackgroundCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptions) + * [`fn withTableColoredBackgroundCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptionsmixin) + * [`fn withTableDataLinksCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptions) + * [`fn withTableDataLinksCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptionsmixin) + * [`fn withTableImageCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptions) + * [`fn withTableImageCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptionsmixin) + * [`fn withTableJsonViewCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptions) + * [`fn withTableJsonViewCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptionsmixin) + * [`fn withTableSparklineCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptions) + * [`fn withTableSparklineCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptionsmixin) + * [`obj TableAutoCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableautocelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) + * [`obj TableBarGaugeCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablebargaugecelloptions) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) + * [`fn withValueDisplayMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithvaluedisplaymode) + * [`obj TableColorTextCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecolortextcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) + * [`obj TableColoredBackgroundCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptions) + * [`fn withApplyToRow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithapplytorow) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) + * [`obj TableDataLinksCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptionswithtype) + * [`obj TableImageCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableimagecelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) + * [`obj TableJsonViewCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) + * [`obj TableSparklineCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptions) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) + * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtransform) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCellHeight(value)`](#fn-optionswithcellheight) + * [`fn withFooter(value)`](#fn-optionswithfooter) + * [`fn withFooterMixin(value)`](#fn-optionswithfootermixin) + * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) + * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) + * [`fn withShowTypeIcons(value=true)`](#fn-optionswithshowtypeicons) + * [`fn withSortBy(value)`](#fn-optionswithsortby) + * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) + * [`obj footer`](#obj-optionsfooter) + * [`fn withCountRows(value=true)`](#fn-optionsfooterwithcountrows) + * [`fn withEnablePagination(value=true)`](#fn-optionsfooterwithenablepagination) + * [`fn withFields(value)`](#fn-optionsfooterwithfields) + * [`fn withFieldsMixin(value)`](#fn-optionsfooterwithfieldsmixin) + * [`fn withReducer(value)`](#fn-optionsfooterwithreducer) + * [`fn withReducerMixin(value)`](#fn-optionsfooterwithreducermixin) + * [`fn withShow(value=true)`](#fn-optionsfooterwithshow) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new table panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAlign + +```jsonnet +fieldConfig.defaults.custom.withAlign(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"left"`, `"right"`, `"center"` + +TODO -- should not be table specific! +TODO docs +###### fn fieldConfig.defaults.custom.withCellOptions + +```jsonnet +fieldConfig.defaults.custom.withCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.withCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withDisplayMode + +```jsonnet +fieldConfig.defaults.custom.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"color-text"`, `"color-background"`, `"color-background-solid"`, `"gradient-gauge"`, `"lcd-gauge"`, `"json-view"`, `"basic"`, `"image"`, `"gauge"`, `"sparkline"`, `"data-links"`, `"custom"` + +Internally, this is the "type" of cell that's being displayed +in the table such as colored text, JSON, gauge, etc. +The color-background-solid, gradient-gauge, and lcd-gauge +modes are deprecated in favor of new cell subOptions +###### fn fieldConfig.defaults.custom.withFilterable + +```jsonnet +fieldConfig.defaults.custom.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withHidden + +```jsonnet +fieldConfig.defaults.custom.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +?? default is missing or false ?? +###### fn fieldConfig.defaults.custom.withHideHeader + +```jsonnet +fieldConfig.defaults.custom.withHideHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Hides any header for a column, useful for columns that show some static content or buttons. +###### fn fieldConfig.defaults.custom.withInspect + +```jsonnet +fieldConfig.defaults.custom.withInspect(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withMinWidth + +```jsonnet +fieldConfig.defaults.custom.withMinWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withWidth + +```jsonnet +fieldConfig.defaults.custom.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### obj fieldConfig.defaults.custom.cellOptions + + +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### obj fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +####### obj fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"gradient"` + +Display mode to the "Colored Background" display +mode for table cells. Either displays a solid color (basic mode) +or a gradient. +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType() +``` + + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCellHeight + +```jsonnet +options.withCellHeight(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sm"`, `"md"`, `"lg"` + +Height of a table cell +#### fn options.withFooter + +```jsonnet +options.withFooter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +#### fn options.withFooterMixin + +```jsonnet +options.withFooterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Footer options +#### fn options.withFrameIndex + +```jsonnet +options.withFrameIndex(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Represents the index of the selected frame +#### fn options.withShowHeader + +```jsonnet +options.withShowHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the panel should show the header +#### fn options.withShowTypeIcons + +```jsonnet +options.withShowTypeIcons(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the header should show icons for the column types +#### fn options.withSortBy + +```jsonnet +options.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### fn options.withSortByMixin + +```jsonnet +options.withSortByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### obj options.footer + + +##### fn options.footer.withCountRows + +```jsonnet +options.footer.withCountRows(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withEnablePagination + +```jsonnet +options.footer.withEnablePagination(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withFields + +```jsonnet +options.footer.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withFieldsMixin + +```jsonnet +options.footer.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withReducer + +```jsonnet +options.footer.withReducer(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withReducerMixin + +```jsonnet +options.footer.withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withShow + +```jsonnet +options.footer.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md new file mode 100644 index 0000000..20748dc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/options/sortBy.md @@ -0,0 +1,34 @@ +# sortBy + + + +## Index + +* [`fn withDesc(value=true)`](#fn-withdesc) +* [`fn withDisplayName(value)`](#fn-withdisplayname) + +## Fields + +### fn withDesc + +```jsonnet +withDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag used to indicate descending sort order +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the display name of the field to sort by \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/table/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/index.md new file mode 100644 index 0000000..360f83b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/index.md @@ -0,0 +1,740 @@ +# text + +grafonnet.panel.text + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCode(value)`](#fn-optionswithcode) + * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) + * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj code`](#obj-optionscode) + * [`fn withLanguage(value)`](#fn-optionscodewithlanguage) + * [`fn withShowLineNumbers(value=true)`](#fn-optionscodewithshowlinenumbers) + * [`fn withShowMiniMap(value=true)`](#fn-optionscodewithshowminimap) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new text panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCode + +```jsonnet +options.withCode(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCodeMixin + +```jsonnet +options.withCodeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withContent + +```jsonnet +options.withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)"` + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"html"`, `"markdown"`, `"code"` + + +#### obj options.code + + +##### fn options.code.withLanguage + +```jsonnet +options.code.withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"json"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"plaintext"` + + +##### fn options.code.withShowLineNumbers + +```jsonnet +options.code.withShowLineNumbers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.code.withShowMiniMap + +```jsonnet +options.code.withShowMiniMap(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/text/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md new file mode 100644 index 0000000..f3961b6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/index.md @@ -0,0 +1,1607 @@ +# timeSeries + +grafonnet.panel.timeSeries + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj timezone`](#obj-optionstimezone) + * [`fn withTimeZoneBrowser()`](#fn-optionstimezonewithtimezonebrowser) + * [`fn withTimeZoneUtc()`](#fn-optionstimezonewithtimezoneutc) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new timeSeries panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.timezone + + +##### fn options.timezone.withTimeZoneBrowser + +```jsonnet +options.timezone.withTimeZoneBrowser() +``` + + +Use the timezone defined by end user web browser +##### fn options.timezone.withTimeZoneUtc + +```jsonnet +options.timezone.withTimeZoneUtc() +``` + + +Use UTC/GMT timezone +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/timeSeries/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/index.md new file mode 100644 index 0000000..01db850 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/index.md @@ -0,0 +1,1560 @@ +# trend + +grafonnet.panel.trend + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new trend panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`integer`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the x field to use (defaults to first number) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/trend/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md new file mode 100644 index 0000000..40bc0dc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/index.md @@ -0,0 +1,1614 @@ +# xyChart + +grafonnet.panel.xyChart + +## Subpackages + +* [options.series](options/series.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLabel(value)`](#fn-fieldconfigdefaultscustomwithlabel) + * [`fn withLabelValue(value)`](#fn-fieldconfigdefaultscustomwithlabelvalue) + * [`fn withLabelValueMixin(value)`](#fn-fieldconfigdefaultscustomwithlabelvaluemixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineColorMixin(value)`](#fn-fieldconfigdefaultscustomwithlinecolormixin) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointColorMixin(value)`](#fn-fieldconfigdefaultscustomwithpointcolormixin) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSizeMixin(value)`](#fn-fieldconfigdefaultscustomwithpointsizemixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShow(value)`](#fn-fieldconfigdefaultscustomwithshow) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj labelValue`](#obj-fieldconfigdefaultscustomlabelvalue) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfixed) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithmode) + * [`obj lineColor`](#obj-fieldconfigdefaultscustomlinecolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfixed) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj pointColor`](#obj-fieldconfigdefaultscustompointcolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointcolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointcolorwithfixed) + * [`obj pointSize`](#obj-fieldconfigdefaultscustompointsize) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointsizewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointsizewithfixed) + * [`fn withMax(value)`](#fn-fieldconfigdefaultscustompointsizewithmax) + * [`fn withMin(value)`](#fn-fieldconfigdefaultscustompointsizewithmin) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustompointsizewithmode) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDims(value)`](#fn-optionswithdims) + * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withSeries(value)`](#fn-optionswithseries) + * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) + * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj dims`](#obj-optionsdims) + * [`fn withExclude(value)`](#fn-optionsdimswithexclude) + * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) + * [`fn withFrame(value)`](#fn-optionsdimswithframe) + * [`fn withX(value)`](#fn-optionsdimswithx) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new xyChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLabel + +```jsonnet +fieldConfig.defaults.custom.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLabelValue + +```jsonnet +fieldConfig.defaults.custom.withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLabelValueMixin + +```jsonnet +fieldConfig.defaults.custom.withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColorMixin + +```jsonnet +fieldConfig.defaults.custom.withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointColorMixin + +```jsonnet +fieldConfig.defaults.custom.withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSizeMixin + +```jsonnet +fieldConfig.defaults.custom.withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShow + +```jsonnet +fieldConfig.defaults.custom.withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.labelValue + + +####### fn fieldConfig.defaults.custom.labelValue.withField + +```jsonnet +fieldConfig.defaults.custom.labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.labelValue.withFixed + +```jsonnet +fieldConfig.defaults.custom.labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.labelValue.withMode + +```jsonnet +fieldConfig.defaults.custom.labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +###### obj fieldConfig.defaults.custom.lineColor + + +####### fn fieldConfig.defaults.custom.lineColor.withField + +```jsonnet +fieldConfig.defaults.custom.lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.lineColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.pointColor + + +####### fn fieldConfig.defaults.custom.pointColor.withField + +```jsonnet +fieldConfig.defaults.custom.pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.pointSize + + +####### fn fieldConfig.defaults.custom.pointSize.withField + +```jsonnet +fieldConfig.defaults.custom.pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointSize.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMax + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMin + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMode + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDims + +```jsonnet +options.withDims(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withDimsMixin + +```jsonnet +options.withDimsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withSeries + +```jsonnet +options.withSeries(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withSeriesMapping + +```jsonnet +options.withSeriesMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Auto is "table" in the UI +#### fn options.withSeriesMixin + +```jsonnet +options.withSeriesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.dims + + +##### fn options.dims.withExclude + +```jsonnet +options.dims.withExclude(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withExcludeMixin + +```jsonnet +options.dims.withExcludeMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withFrame + +```jsonnet +options.dims.withFrame(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.dims.withX + +```jsonnet +options.dims.withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md new file mode 100644 index 0000000..30e0152 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/options/series.md @@ -0,0 +1,663 @@ +# series + + + +## Index + +* [`fn withAxisBorderShow(value=true)`](#fn-withaxisbordershow) +* [`fn withAxisCenteredZero(value=true)`](#fn-withaxiscenteredzero) +* [`fn withAxisColorMode(value)`](#fn-withaxiscolormode) +* [`fn withAxisGridShow(value=true)`](#fn-withaxisgridshow) +* [`fn withAxisLabel(value)`](#fn-withaxislabel) +* [`fn withAxisPlacement(value)`](#fn-withaxisplacement) +* [`fn withAxisSoftMax(value)`](#fn-withaxissoftmax) +* [`fn withAxisSoftMin(value)`](#fn-withaxissoftmin) +* [`fn withAxisWidth(value)`](#fn-withaxiswidth) +* [`fn withFrame(value)`](#fn-withframe) +* [`fn withHideFrom(value)`](#fn-withhidefrom) +* [`fn withHideFromMixin(value)`](#fn-withhidefrommixin) +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withLabelValue(value)`](#fn-withlabelvalue) +* [`fn withLabelValueMixin(value)`](#fn-withlabelvaluemixin) +* [`fn withLineColor(value)`](#fn-withlinecolor) +* [`fn withLineColorMixin(value)`](#fn-withlinecolormixin) +* [`fn withLineStyle(value)`](#fn-withlinestyle) +* [`fn withLineStyleMixin(value)`](#fn-withlinestylemixin) +* [`fn withLineWidth(value)`](#fn-withlinewidth) +* [`fn withName(value)`](#fn-withname) +* [`fn withPointColor(value)`](#fn-withpointcolor) +* [`fn withPointColorMixin(value)`](#fn-withpointcolormixin) +* [`fn withPointSize(value)`](#fn-withpointsize) +* [`fn withPointSizeMixin(value)`](#fn-withpointsizemixin) +* [`fn withScaleDistribution(value)`](#fn-withscaledistribution) +* [`fn withScaleDistributionMixin(value)`](#fn-withscaledistributionmixin) +* [`fn withShow(value)`](#fn-withshow) +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) +* [`obj hideFrom`](#obj-hidefrom) + * [`fn withLegend(value=true)`](#fn-hidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-hidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-hidefromwithviz) +* [`obj labelValue`](#obj-labelvalue) + * [`fn withField(value)`](#fn-labelvaluewithfield) + * [`fn withFixed(value)`](#fn-labelvaluewithfixed) + * [`fn withMode(value)`](#fn-labelvaluewithmode) +* [`obj lineColor`](#obj-linecolor) + * [`fn withField(value)`](#fn-linecolorwithfield) + * [`fn withFixed(value)`](#fn-linecolorwithfixed) +* [`obj lineStyle`](#obj-linestyle) + * [`fn withDash(value)`](#fn-linestylewithdash) + * [`fn withDashMixin(value)`](#fn-linestylewithdashmixin) + * [`fn withFill(value)`](#fn-linestylewithfill) +* [`obj pointColor`](#obj-pointcolor) + * [`fn withField(value)`](#fn-pointcolorwithfield) + * [`fn withFixed(value)`](#fn-pointcolorwithfixed) +* [`obj pointSize`](#obj-pointsize) + * [`fn withField(value)`](#fn-pointsizewithfield) + * [`fn withFixed(value)`](#fn-pointsizewithfixed) + * [`fn withMax(value)`](#fn-pointsizewithmax) + * [`fn withMin(value)`](#fn-pointsizewithmin) + * [`fn withMode(value)`](#fn-pointsizewithmode) +* [`obj scaleDistribution`](#obj-scaledistribution) + * [`fn withLinearThreshold(value)`](#fn-scaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-scaledistributionwithlog) + * [`fn withType(value)`](#fn-scaledistributionwithtype) + +## Fields + +### fn withAxisBorderShow + +```jsonnet +withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisCenteredZero + +```jsonnet +withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisColorMode + +```jsonnet +withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +### fn withAxisGridShow + +```jsonnet +withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisLabel + +```jsonnet +withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withAxisPlacement + +```jsonnet +withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +### fn withAxisSoftMax + +```jsonnet +withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisSoftMin + +```jsonnet +withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisWidth + +```jsonnet +withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withFrame + +```jsonnet +withFrame(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withHideFrom + +```jsonnet +withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withHideFromMixin + +```jsonnet +withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +### fn withLabelValue + +```jsonnet +withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelValueMixin + +```jsonnet +withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColor + +```jsonnet +withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColorMixin + +```jsonnet +withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineStyle + +```jsonnet +withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineStyleMixin + +```jsonnet +withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineWidth + +```jsonnet +withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPointColor + +```jsonnet +withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointColorMixin + +```jsonnet +withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSize + +```jsonnet +withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSizeMixin + +```jsonnet +withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScaleDistribution + +```jsonnet +withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withScaleDistributionMixin + +```jsonnet +withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withShow + +```jsonnet +withShow(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj hideFrom + + +#### fn hideFrom.withLegend + +```jsonnet +hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withTooltip + +```jsonnet +hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withViz + +```jsonnet +hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj labelValue + + +#### fn labelValue.withField + +```jsonnet +labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn labelValue.withFixed + +```jsonnet +labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn labelValue.withMode + +```jsonnet +labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +### obj lineColor + + +#### fn lineColor.withField + +```jsonnet +lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn lineColor.withFixed + +```jsonnet +lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj lineStyle + + +#### fn lineStyle.withDash + +```jsonnet +lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withDashMixin + +```jsonnet +lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withFill + +```jsonnet +lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +### obj pointColor + + +#### fn pointColor.withField + +```jsonnet +pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointColor.withFixed + +```jsonnet +pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj pointSize + + +#### fn pointSize.withField + +```jsonnet +pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointSize.withFixed + +```jsonnet +pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMax + +```jsonnet +pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMin + +```jsonnet +pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMode + +```jsonnet +pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + + +### obj scaleDistribution + + +#### fn scaleDistribution.withLinearThreshold + +```jsonnet +scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withLog + +```jsonnet +scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withType + +```jsonnet +scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/panel/xyChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/preferences.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/preferences.md new file mode 100644 index 0000000..79b7bfc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/preferences.md @@ -0,0 +1,210 @@ +# preferences + +grafonnet.preferences + +## Index + +* [`fn withCookiePreferences(value)`](#fn-withcookiepreferences) +* [`fn withCookiePreferencesMixin(value)`](#fn-withcookiepreferencesmixin) +* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) +* [`fn withLanguage(value)`](#fn-withlanguage) +* [`fn withQueryHistory(value)`](#fn-withqueryhistory) +* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) +* [`fn withTheme(value)`](#fn-withtheme) +* [`fn withTimezone(value)`](#fn-withtimezone) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj cookiePreferences`](#obj-cookiepreferences) + * [`fn withAnalytics(value)`](#fn-cookiepreferenceswithanalytics) + * [`fn withAnalyticsMixin(value)`](#fn-cookiepreferenceswithanalyticsmixin) + * [`fn withFunctional(value)`](#fn-cookiepreferenceswithfunctional) + * [`fn withFunctionalMixin(value)`](#fn-cookiepreferenceswithfunctionalmixin) + * [`fn withPerformance(value)`](#fn-cookiepreferenceswithperformance) + * [`fn withPerformanceMixin(value)`](#fn-cookiepreferenceswithperformancemixin) +* [`obj queryHistory`](#obj-queryhistory) + * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) + +## Fields + +### fn withCookiePreferences + +```jsonnet +withCookiePreferences(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCookiePreferencesMixin + +```jsonnet +withCookiePreferencesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHomeDashboardUID + +```jsonnet +withHomeDashboardUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID for the home dashboard +### fn withLanguage + +```jsonnet +withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Selected language (beta) +### fn withQueryHistory + +```jsonnet +withQueryHistory(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryHistoryMixin + +```jsonnet +withQueryHistoryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTheme + +```jsonnet +withTheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +light, dark, empty is default +### fn withTimezone + +```jsonnet +withTimezone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The timezone selection +TODO: this should use the timezone defined in common +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +day of the week (sunday, monday, etc) +### obj cookiePreferences + + +#### fn cookiePreferences.withAnalytics + +```jsonnet +cookiePreferences.withAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withAnalyticsMixin + +```jsonnet +cookiePreferences.withAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctional + +```jsonnet +cookiePreferences.withFunctional(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctionalMixin + +```jsonnet +cookiePreferences.withFunctionalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformance + +```jsonnet +cookiePreferences.withPerformance(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformanceMixin + +```jsonnet +cookiePreferences.withPerformanceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj queryHistory + + +#### fn queryHistory.withHomeTab + +```jsonnet +queryHistory.withHomeTab(value) +``` + +PARAMETERS: + +* **value** (`string`) + +one of: '' | 'query' | 'starred'; \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/publicdashboard.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/publicdashboard.md new file mode 100644 index 0000000..9cb78fb --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/publicdashboard.md @@ -0,0 +1,84 @@ +# publicdashboard + +grafonnet.publicdashboard + +## Index + +* [`fn withAccessToken(value)`](#fn-withaccesstoken) +* [`fn withAnnotationsEnabled(value=true)`](#fn-withannotationsenabled) +* [`fn withDashboardUid(value)`](#fn-withdashboarduid) +* [`fn withIsEnabled(value=true)`](#fn-withisenabled) +* [`fn withTimeSelectionEnabled(value=true)`](#fn-withtimeselectionenabled) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withAccessToken + +```jsonnet +withAccessToken(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public access token +### fn withAnnotationsEnabled + +```jsonnet +withAnnotationsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if annotations are enabled +### fn withDashboardUid + +```jsonnet +withDashboardUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Dashboard unique identifier referenced by this public dashboard +### fn withIsEnabled + +```jsonnet +withIsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the public dashboard is enabled +### fn withTimeSelectionEnabled + +```jsonnet +withTimeSelectionEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the time range picker is enabled +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public dashboard identifier \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md new file mode 100644 index 0000000..43b6cf5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md @@ -0,0 +1,69 @@ +# dimensionFilters + + + +## Index + +* [`fn withDimension(value)`](#fn-withdimension) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperator(value)`](#fn-withoperator) + +## Fields + +### fn withDimension + +```jsonnet +withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of Dimension to be filtered on. +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated filter is deprecated in favour of filters to support multiselect. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/resources.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/resources.md new file mode 100644 index 0000000..18bb633 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureMonitor/resources.md @@ -0,0 +1,68 @@ +# resources + + + +## Index + +* [`fn withMetricNamespace(value)`](#fn-withmetricnamespace) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withResourceName(value)`](#fn-withresourcename) +* [`fn withSubscription(value)`](#fn-withsubscription) + +## Fields + +### fn withMetricNamespace + +```jsonnet +withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceName + +```jsonnet +withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureTraces/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureTraces/filters.md new file mode 100644 index 0000000..0c5c718 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/azureTraces/filters.md @@ -0,0 +1,57 @@ +# filters + + + +## Index + +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperation(value)`](#fn-withoperation) +* [`fn withProperty(value)`](#fn-withproperty) + +## Fields + +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withOperation + +```jsonnet +withOperation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Comparison operator to use. Either equals or not equals. +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Property name, auto-populated based on available traces. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md new file mode 100644 index 0000000..f60f70e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/azureMonitor/index.md @@ -0,0 +1,1495 @@ +# azureMonitor + +grafonnet.query.azureMonitor + +## Subpackages + +* [azureMonitor.dimensionFilters](azureMonitor/dimensionFilters.md) +* [azureMonitor.resources](azureMonitor/resources.md) +* [azureTraces.filters](azureTraces/filters.md) + +## Index + +* [`fn withAzureLogAnalytics(value)`](#fn-withazureloganalytics) +* [`fn withAzureLogAnalyticsMixin(value)`](#fn-withazureloganalyticsmixin) +* [`fn withAzureMonitor(value)`](#fn-withazuremonitor) +* [`fn withAzureMonitorMixin(value)`](#fn-withazuremonitormixin) +* [`fn withAzureResourceGraph(value)`](#fn-withazureresourcegraph) +* [`fn withAzureResourceGraphMixin(value)`](#fn-withazureresourcegraphmixin) +* [`fn withAzureTraces(value)`](#fn-withazuretraces) +* [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) +* [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withNamespace(value)`](#fn-withnamespace) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResource(value)`](#fn-withresource) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withSubscription(value)`](#fn-withsubscription) +* [`fn withSubscriptions(value)`](#fn-withsubscriptions) +* [`fn withSubscriptionsMixin(value)`](#fn-withsubscriptionsmixin) +* [`obj azureLogAnalytics`](#obj-azureloganalytics) + * [`fn withDashboardTime(value=true)`](#fn-azureloganalyticswithdashboardtime) + * [`fn withIntersectTime(value=true)`](#fn-azureloganalyticswithintersecttime) + * [`fn withQuery(value)`](#fn-azureloganalyticswithquery) + * [`fn withResource(value)`](#fn-azureloganalyticswithresource) + * [`fn withResources(value)`](#fn-azureloganalyticswithresources) + * [`fn withResourcesMixin(value)`](#fn-azureloganalyticswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azureloganalyticswithresultformat) + * [`fn withTimeColumn(value)`](#fn-azureloganalyticswithtimecolumn) + * [`fn withWorkspace(value)`](#fn-azureloganalyticswithworkspace) +* [`obj azureMonitor`](#obj-azuremonitor) + * [`fn withAggregation(value)`](#fn-azuremonitorwithaggregation) + * [`fn withAlias(value)`](#fn-azuremonitorwithalias) + * [`fn withAllowedTimeGrainsMs(value)`](#fn-azuremonitorwithallowedtimegrainsms) + * [`fn withAllowedTimeGrainsMsMixin(value)`](#fn-azuremonitorwithallowedtimegrainsmsmixin) + * [`fn withCustomNamespace(value)`](#fn-azuremonitorwithcustomnamespace) + * [`fn withDimension(value)`](#fn-azuremonitorwithdimension) + * [`fn withDimensionFilter(value)`](#fn-azuremonitorwithdimensionfilter) + * [`fn withDimensionFilters(value)`](#fn-azuremonitorwithdimensionfilters) + * [`fn withDimensionFiltersMixin(value)`](#fn-azuremonitorwithdimensionfiltersmixin) + * [`fn withMetricDefinition(value)`](#fn-azuremonitorwithmetricdefinition) + * [`fn withMetricName(value)`](#fn-azuremonitorwithmetricname) + * [`fn withMetricNamespace(value)`](#fn-azuremonitorwithmetricnamespace) + * [`fn withRegion(value)`](#fn-azuremonitorwithregion) + * [`fn withResourceGroup(value)`](#fn-azuremonitorwithresourcegroup) + * [`fn withResourceName(value)`](#fn-azuremonitorwithresourcename) + * [`fn withResourceUri(value)`](#fn-azuremonitorwithresourceuri) + * [`fn withResources(value)`](#fn-azuremonitorwithresources) + * [`fn withResourcesMixin(value)`](#fn-azuremonitorwithresourcesmixin) + * [`fn withTimeGrain(value)`](#fn-azuremonitorwithtimegrain) + * [`fn withTimeGrainUnit(value)`](#fn-azuremonitorwithtimegrainunit) + * [`fn withTop(value)`](#fn-azuremonitorwithtop) +* [`obj azureResourceGraph`](#obj-azureresourcegraph) + * [`fn withQuery(value)`](#fn-azureresourcegraphwithquery) + * [`fn withResultFormat(value)`](#fn-azureresourcegraphwithresultformat) +* [`obj azureTraces`](#obj-azuretraces) + * [`fn withFilters(value)`](#fn-azuretraceswithfilters) + * [`fn withFiltersMixin(value)`](#fn-azuretraceswithfiltersmixin) + * [`fn withOperationId(value)`](#fn-azuretraceswithoperationid) + * [`fn withQuery(value)`](#fn-azuretraceswithquery) + * [`fn withResources(value)`](#fn-azuretraceswithresources) + * [`fn withResourcesMixin(value)`](#fn-azuretraceswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) + * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) + * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) +* [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) + * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) + * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) + * [`fn withAppInsightsMetricNameQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequery) + * [`fn withAppInsightsMetricNameQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequerymixin) + * [`fn withMetricDefinitionsQuery(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquery) + * [`fn withMetricDefinitionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquerymixin) + * [`fn withMetricNamesQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquery) + * [`fn withMetricNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquerymixin) + * [`fn withMetricNamespaceQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequery) + * [`fn withMetricNamespaceQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequerymixin) + * [`fn withResourceGroupsQuery(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquery) + * [`fn withResourceGroupsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquerymixin) + * [`fn withResourceNamesQuery(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquery) + * [`fn withResourceNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquerymixin) + * [`fn withSubscriptionsQuery(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquery) + * [`fn withSubscriptionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquerymixin) + * [`fn withUnknownQuery(value)`](#fn-grafanatemplatevariablefnwithunknownquery) + * [`fn withUnknownQueryMixin(value)`](#fn-grafanatemplatevariablefnwithunknownquerymixin) + * [`fn withWorkspacesQuery(value)`](#fn-grafanatemplatevariablefnwithworkspacesquery) + * [`fn withWorkspacesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithworkspacesquerymixin) + * [`obj AppInsightsGroupByQuery`](#obj-grafanatemplatevariablefnappinsightsgroupbyquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) + * [`fn withMetricName(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithmetricname) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithrawquery) + * [`obj AppInsightsMetricNameQuery`](#obj-grafanatemplatevariablefnappinsightsmetricnamequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithrawquery) + * [`obj MetricDefinitionsQuery`](#obj-grafanatemplatevariablefnmetricdefinitionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithsubscription) + * [`obj MetricNamesQuery`](#obj-grafanatemplatevariablefnmetricnamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithsubscription) + * [`obj MetricNamespaceQuery`](#obj-grafanatemplatevariablefnmetricnamespacequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithsubscription) + * [`obj ResourceGroupsQuery`](#obj-grafanatemplatevariablefnresourcegroupsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithsubscription) + * [`obj ResourceNamesQuery`](#obj-grafanatemplatevariablefnresourcenamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithresourcegroup) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithsubscription) + * [`obj SubscriptionsQuery`](#obj-grafanatemplatevariablefnsubscriptionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithrawquery) + * [`obj UnknownQuery`](#obj-grafanatemplatevariablefnunknownquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnunknownquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnunknownquerywithrawquery) + * [`obj WorkspacesQuery`](#obj-grafanatemplatevariablefnworkspacesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithsubscription) + +## Fields + +### fn withAzureLogAnalytics + +```jsonnet +withAzureLogAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureLogAnalyticsMixin + +```jsonnet +withAzureLogAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureMonitor + +```jsonnet +withAzureMonitor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureMonitorMixin + +```jsonnet +withAzureMonitorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureResourceGraph + +```jsonnet +withAzureResourceGraph(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureResourceGraphMixin + +```jsonnet +withAzureResourceGraphMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAzureTraces + +```jsonnet +withAzureTraces(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withAzureTracesMixin + +```jsonnet +withAzureTracesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withGrafanaTemplateVariableFn + +```jsonnet +withGrafanaTemplateVariableFn(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withGrafanaTemplateVariableFnMixin + +```jsonnet +withGrafanaTemplateVariableFnMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withNamespace + +```jsonnet +withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure Monitor query type. +queryType: #AzureQueryType +### fn withResource + +```jsonnet +withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Template variables params. These exist for backwards compatiblity with legacy template variables. +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure subscription containing the resource(s) to be queried. +### fn withSubscriptions + +```jsonnet +withSubscriptions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### fn withSubscriptionsMixin + +```jsonnet +withSubscriptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### obj azureLogAnalytics + + +#### fn azureLogAnalytics.withDashboardTime + +```jsonnet +azureLogAnalytics.withDashboardTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false. +#### fn azureLogAnalytics.withIntersectTime + +```jsonnet +azureLogAnalytics.withIntersectTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated Use dashboardTime instead +#### fn azureLogAnalytics.withQuery + +```jsonnet +azureLogAnalytics.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureLogAnalytics.withResource + +```jsonnet +azureLogAnalytics.withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureLogAnalytics.withResources + +```jsonnet +azureLogAnalytics.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResourcesMixin + +```jsonnet +azureLogAnalytics.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResultFormat + +```jsonnet +azureLogAnalytics.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + + +#### fn azureLogAnalytics.withTimeColumn + +```jsonnet +azureLogAnalytics.withTimeColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated +#### fn azureLogAnalytics.withWorkspace + +```jsonnet +azureLogAnalytics.withWorkspace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Workspace ID. This was removed in Grafana 8, but remains for backwards compat. +### obj azureMonitor + + +#### fn azureMonitor.withAggregation + +```jsonnet +azureMonitor.withAggregation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. +#### fn azureMonitor.withAlias + +```jsonnet +azureMonitor.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. +#### fn azureMonitor.withAllowedTimeGrainsMs + +```jsonnet +azureMonitor.withAllowedTimeGrainsMs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withAllowedTimeGrainsMsMixin + +```jsonnet +azureMonitor.withAllowedTimeGrainsMsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withCustomNamespace + +```jsonnet +azureMonitor.withCustomNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used as the value for the metricNamespace property when it's different from the resource namespace. +#### fn azureMonitor.withDimension + +```jsonnet +azureMonitor.withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilter + +```jsonnet +azureMonitor.withDimensionFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilters + +```jsonnet +azureMonitor.withDimensionFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withDimensionFiltersMixin + +```jsonnet +azureMonitor.withDimensionFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withMetricDefinition + +```jsonnet +azureMonitor.withMetricDefinition(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use metricNamespace instead +#### fn azureMonitor.withMetricName + +```jsonnet +azureMonitor.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The metric to query data for within the specified metricNamespace. e.g. UsedCapacity +#### fn azureMonitor.withMetricNamespace + +```jsonnet +azureMonitor.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +metricNamespace is used as the resource type (or resource namespace). +It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts +Kept the name of the variable as metricNamespace to avoid backward incompatibility issues. +#### fn azureMonitor.withRegion + +```jsonnet +azureMonitor.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The Azure region containing the resource(s). +#### fn azureMonitor.withResourceGroup + +```jsonnet +azureMonitor.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceName + +```jsonnet +azureMonitor.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceUri + +```jsonnet +azureMonitor.withResourceUri(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resourceGroup, resourceName and metricNamespace instead +#### fn azureMonitor.withResources + +```jsonnet +azureMonitor.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withResourcesMixin + +```jsonnet +azureMonitor.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withTimeGrain + +```jsonnet +azureMonitor.withTimeGrain(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The granularity of data points to be queried. Defaults to auto. +#### fn azureMonitor.withTimeGrainUnit + +```jsonnet +azureMonitor.withTimeGrainUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated +#### fn azureMonitor.withTop + +```jsonnet +azureMonitor.withTop(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Maximum number of records to return. Defaults to 10. +### obj azureResourceGraph + + +#### fn azureResourceGraph.withQuery + +```jsonnet +azureResourceGraph.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure Resource Graph KQL query to be executed. +#### fn azureResourceGraph.withResultFormat + +```jsonnet +azureResourceGraph.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the format results should be returned as. Defaults to table. +### obj azureTraces + + +#### fn azureTraces.withFilters + +```jsonnet +azureTraces.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withFiltersMixin + +```jsonnet +azureTraces.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withOperationId + +```jsonnet +azureTraces.withOperationId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Operation ID. Used only for Traces queries. +#### fn azureTraces.withQuery + +```jsonnet +azureTraces.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureTraces.withResources + +```jsonnet +azureTraces.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResourcesMixin + +```jsonnet +azureTraces.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResultFormat + +```jsonnet +azureTraces.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + + +#### fn azureTraces.withTraceTypes + +```jsonnet +azureTraces.withTraceTypes(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +#### fn azureTraces.withTraceTypesMixin + +```jsonnet +azureTraces.withTraceTypesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +### obj grafanaTemplateVariableFn + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQuery + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQuery + +```jsonnet +grafanaTemplateVariableFn.withUnknownQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withUnknownQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQuery + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj grafanaTemplateVariableFn.AppInsightsGroupByQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricDefinitionsQuery + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamesQuery + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamespaceQuery + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceGroupsQuery + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceNamesQuery + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.SubscriptionsQuery + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.UnknownQuery + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.WorkspacesQuery + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md new file mode 100644 index 0000000..a59d777 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md @@ -0,0 +1,57 @@ +# logGroups + + + +## Index + +* [`fn withAccountId(value)`](#fn-withaccountid) +* [`fn withAccountLabel(value)`](#fn-withaccountlabel) +* [`fn withArn(value)`](#fn-witharn) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withAccountId + +```jsonnet +withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AccountId of the log group +### fn withAccountLabel + +```jsonnet +withAccountLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Label of the log group +### fn withArn + +```jsonnet +withArn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ARN of the log group +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the log group \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md new file mode 100644 index 0000000..71a7abe --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/cloudWatch/index.md @@ -0,0 +1,1245 @@ +# cloudWatch + +grafonnet.query.cloudWatch + +## Subpackages + +* [CloudWatchLogsQuery.logGroups](CloudWatchLogsQuery/logGroups.md) +* [CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters](CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md) +* [CloudWatchMetricsQuery.sql.orderBy.parameters](CloudWatchMetricsQuery/sql/orderBy/parameters.md) +* [CloudWatchMetricsQuery.sql.select.parameters](CloudWatchMetricsQuery/sql/select/parameters.md) + +## Index + +* [`obj CloudWatchAnnotationQuery`](#obj-cloudwatchannotationquery) + * [`fn withAccountId(value)`](#fn-cloudwatchannotationquerywithaccountid) + * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) + * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) + * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) + * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) + * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchannotationquerywithmatchexact) + * [`fn withMetricName(value)`](#fn-cloudwatchannotationquerywithmetricname) + * [`fn withNamespace(value)`](#fn-cloudwatchannotationquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchannotationquerywithperiod) + * [`fn withPrefixMatching(value=true)`](#fn-cloudwatchannotationquerywithprefixmatching) + * [`fn withQueryMode(value)`](#fn-cloudwatchannotationquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchannotationquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchannotationquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchannotationquerywithregion) + * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) +* [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) + * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) + * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) + * [`fn withLogGroupNames(value)`](#fn-cloudwatchlogsquerywithloggroupnames) + * [`fn withLogGroupNamesMixin(value)`](#fn-cloudwatchlogsquerywithloggroupnamesmixin) + * [`fn withLogGroups(value)`](#fn-cloudwatchlogsquerywithloggroups) + * [`fn withLogGroupsMixin(value)`](#fn-cloudwatchlogsquerywithloggroupsmixin) + * [`fn withQueryMode(value)`](#fn-cloudwatchlogsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchlogsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchlogsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) + * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) + * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) +* [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) + * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) + * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) + * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) + * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) + * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchmetricsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchmetricsquerywithid) + * [`fn withLabel(value)`](#fn-cloudwatchmetricsquerywithlabel) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchmetricsquerywithmatchexact) + * [`fn withMetricEditorMode(value)`](#fn-cloudwatchmetricsquerywithmetriceditormode) + * [`fn withMetricName(value)`](#fn-cloudwatchmetricsquerywithmetricname) + * [`fn withMetricQueryType(value)`](#fn-cloudwatchmetricsquerywithmetricquerytype) + * [`fn withNamespace(value)`](#fn-cloudwatchmetricsquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchmetricsquerywithperiod) + * [`fn withQueryMode(value)`](#fn-cloudwatchmetricsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchmetricsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchmetricsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchmetricsquerywithregion) + * [`fn withSql(value)`](#fn-cloudwatchmetricsquerywithsql) + * [`fn withSqlExpression(value)`](#fn-cloudwatchmetricsquerywithsqlexpression) + * [`fn withSqlMixin(value)`](#fn-cloudwatchmetricsquerywithsqlmixin) + * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) + * [`obj sql`](#obj-cloudwatchmetricsquerysql) + * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) + * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) + * [`fn withGroupBy(value)`](#fn-cloudwatchmetricsquerysqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-cloudwatchmetricsquerysqlwithlimit) + * [`fn withOrderBy(value)`](#fn-cloudwatchmetricsquerysqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-cloudwatchmetricsquerysqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithorderbymixin) + * [`fn withSelect(value)`](#fn-cloudwatchmetricsquerysqlwithselect) + * [`fn withSelectMixin(value)`](#fn-cloudwatchmetricsquerysqlwithselectmixin) + * [`fn withWhere(value)`](#fn-cloudwatchmetricsquerysqlwithwhere) + * [`fn withWhereMixin(value)`](#fn-cloudwatchmetricsquerysqlwithwheremixin) + * [`obj from`](#obj-cloudwatchmetricsquerysqlfrom) + * [`fn withQueryEditorFunctionExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpression) + * [`fn withQueryEditorFunctionExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpressionmixin) + * [`fn withQueryEditorPropertyExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpression) + * [`fn withQueryEditorPropertyExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpressionmixin) + * [`obj QueryEditorFunctionExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpression) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) + * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) + * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) + * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) + * [`obj property`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionproperty) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithname) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithtype) + * [`obj groupBy`](#obj-cloudwatchmetricsquerysqlgroupby) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithtype) + * [`obj orderBy`](#obj-cloudwatchmetricsquerysqlorderby) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbywithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlorderbywithtype) + * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlselectwithtype) + * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlwherewithtype) + +## Fields + +### obj CloudWatchAnnotationQuery + + +#### fn CloudWatchAnnotationQuery.withAccountId + +```jsonnet +CloudWatchAnnotationQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchAnnotationQuery.withActionPrefix + +```jsonnet +CloudWatchAnnotationQuery.withActionPrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use this parameter to filter the results of the operation to only those alarms +that use a certain alarm action. For example, you could specify the ARN of +an SNS topic to find all alarms that send notifications to that topic. +e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action` +but not match `arn:aws:sns:us-east-1:123456789012:your-app-action` +#### fn CloudWatchAnnotationQuery.withAlarmNamePrefix + +```jsonnet +CloudWatchAnnotationQuery.withAlarmNamePrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An alarm name prefix. If you specify this parameter, you receive information +about all alarms that have names that start with this prefix. +e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu` +#### fn CloudWatchAnnotationQuery.withDatasource + +```jsonnet +CloudWatchAnnotationQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchAnnotationQuery.withDimensions + +```jsonnet +CloudWatchAnnotationQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withDimensionsMixin + +```jsonnet +CloudWatchAnnotationQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withHide + +```jsonnet +CloudWatchAnnotationQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchAnnotationQuery.withMatchExact + +```jsonnet +CloudWatchAnnotationQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchAnnotationQuery.withMetricName + +```jsonnet +CloudWatchAnnotationQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchAnnotationQuery.withNamespace + +```jsonnet +CloudWatchAnnotationQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchAnnotationQuery.withPeriod + +```jsonnet +CloudWatchAnnotationQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchAnnotationQuery.withPrefixMatching + +```jsonnet +CloudWatchAnnotationQuery.withPrefixMatching(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix +#### fn CloudWatchAnnotationQuery.withQueryMode + +```jsonnet +CloudWatchAnnotationQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchAnnotationQuery.withQueryType + +```jsonnet +CloudWatchAnnotationQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchAnnotationQuery.withRefId + +```jsonnet +CloudWatchAnnotationQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchAnnotationQuery.withRegion + +```jsonnet +CloudWatchAnnotationQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchAnnotationQuery.withStatistic + +```jsonnet +CloudWatchAnnotationQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchAnnotationQuery.withStatistics + +```jsonnet +CloudWatchAnnotationQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchAnnotationQuery.withStatisticsMixin + +```jsonnet +CloudWatchAnnotationQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +### obj CloudWatchLogsQuery + + +#### fn CloudWatchLogsQuery.withDatasource + +```jsonnet +CloudWatchLogsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchLogsQuery.withExpression + +```jsonnet +CloudWatchLogsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The CloudWatch Logs Insights query to execute +#### fn CloudWatchLogsQuery.withHide + +```jsonnet +CloudWatchLogsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchLogsQuery.withId + +```jsonnet +CloudWatchLogsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn CloudWatchLogsQuery.withLogGroupNames + +```jsonnet +CloudWatchLogsQuery.withLogGroupNames(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroupNamesMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupNamesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroups + +```jsonnet +CloudWatchLogsQuery.withLogGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withLogGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withQueryMode + +```jsonnet +CloudWatchLogsQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchLogsQuery.withQueryType + +```jsonnet +CloudWatchLogsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchLogsQuery.withRefId + +```jsonnet +CloudWatchLogsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchLogsQuery.withRegion + +```jsonnet +CloudWatchLogsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the logs +#### fn CloudWatchLogsQuery.withStatsGroups + +```jsonnet +CloudWatchLogsQuery.withStatsGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +#### fn CloudWatchLogsQuery.withStatsGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withStatsGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +### obj CloudWatchMetricsQuery + + +#### fn CloudWatchMetricsQuery.withAccountId + +```jsonnet +CloudWatchMetricsQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchMetricsQuery.withAlias + +```jsonnet +CloudWatchMetricsQuery.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Deprecated: use label +@deprecated use label +#### fn CloudWatchMetricsQuery.withDatasource + +```jsonnet +CloudWatchMetricsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchMetricsQuery.withDimensions + +```jsonnet +CloudWatchMetricsQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withDimensionsMixin + +```jsonnet +CloudWatchMetricsQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withExpression + +```jsonnet +CloudWatchMetricsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Math expression query +#### fn CloudWatchMetricsQuery.withHide + +```jsonnet +CloudWatchMetricsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchMetricsQuery.withId + +```jsonnet +CloudWatchMetricsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. +#### fn CloudWatchMetricsQuery.withLabel + +```jsonnet +CloudWatchMetricsQuery.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. +#### fn CloudWatchMetricsQuery.withMatchExact + +```jsonnet +CloudWatchMetricsQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchMetricsQuery.withMetricEditorMode + +```jsonnet +CloudWatchMetricsQuery.withMetricEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +#### fn CloudWatchMetricsQuery.withMetricName + +```jsonnet +CloudWatchMetricsQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchMetricsQuery.withMetricQueryType + +```jsonnet +CloudWatchMetricsQuery.withMetricQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +#### fn CloudWatchMetricsQuery.withNamespace + +```jsonnet +CloudWatchMetricsQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchMetricsQuery.withPeriod + +```jsonnet +CloudWatchMetricsQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchMetricsQuery.withQueryMode + +```jsonnet +CloudWatchMetricsQuery.withQueryMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + + +#### fn CloudWatchMetricsQuery.withQueryType + +```jsonnet +CloudWatchMetricsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchMetricsQuery.withRefId + +```jsonnet +CloudWatchMetricsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchMetricsQuery.withRegion + +```jsonnet +CloudWatchMetricsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchMetricsQuery.withSql + +```jsonnet +CloudWatchMetricsQuery.withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn CloudWatchMetricsQuery.withSqlExpression + +```jsonnet +CloudWatchMetricsQuery.withSqlExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string. +#### fn CloudWatchMetricsQuery.withSqlMixin + +```jsonnet +CloudWatchMetricsQuery.withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn CloudWatchMetricsQuery.withStatistic + +```jsonnet +CloudWatchMetricsQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchMetricsQuery.withStatistics + +```jsonnet +CloudWatchMetricsQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchMetricsQuery.withStatisticsMixin + +```jsonnet +CloudWatchMetricsQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### obj CloudWatchMetricsQuery.sql + + +##### fn CloudWatchMetricsQuery.sql.withFrom + +```jsonnet +CloudWatchMetricsQuery.sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withFromMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withGroupBy + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withGroupByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withLimit + +```jsonnet +CloudWatchMetricsQuery.sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +LIMIT part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withOrderBy + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withOrderByDirection + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The sort order of the SQL expression, `ASC` or `DESC` +##### fn CloudWatchMetricsQuery.sql.withOrderByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withSelect + +```jsonnet +CloudWatchMetricsQuery.sql.withSelect(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withSelectMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withSelectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withWhere + +```jsonnet +CloudWatchMetricsQuery.sql.withWhere(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn CloudWatchMetricsQuery.sql.withWhereMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withWhereMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### obj CloudWatchMetricsQuery.sql.from + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType() +``` + + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType() +``` + + + +####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + + +##### obj CloudWatchMetricsQuery.sql.groupBy + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +##### obj CloudWatchMetricsQuery.sql.orderBy + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withName + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.select + + +###### fn CloudWatchMetricsQuery.sql.select.withName + +```jsonnet +CloudWatchMetricsQuery.sql.select.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withType + +```jsonnet +CloudWatchMetricsQuery.sql.select.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.where + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withType + +```jsonnet +CloudWatchMetricsQuery.sql.where.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md new file mode 100644 index 0000000..34d2819 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md @@ -0,0 +1,32 @@ +# filters + + + +## Index + +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withQuery(value)`](#fn-withquery) + +## Fields + +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md new file mode 100644 index 0000000..f98cbde --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/bucketAggs/index.md @@ -0,0 +1,567 @@ +# bucketAggs + + + +## Subpackages + +* [Filters.settings.filters](Filters/settings/filters.md) + +## Index + +* [`obj DateHistogram`](#obj-datehistogram) + * [`fn withField(value)`](#fn-datehistogramwithfield) + * [`fn withId(value)`](#fn-datehistogramwithid) + * [`fn withSettings(value)`](#fn-datehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) + * [`fn withType()`](#fn-datehistogramwithtype) + * [`obj settings`](#obj-datehistogramsettings) + * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) +* [`obj Filters`](#obj-filters) + * [`fn withId(value)`](#fn-filterswithid) + * [`fn withSettings(value)`](#fn-filterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) + * [`fn withType()`](#fn-filterswithtype) + * [`obj settings`](#obj-filterssettings) + * [`fn withFilters(value)`](#fn-filterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) +* [`obj GeoHashGrid`](#obj-geohashgrid) + * [`fn withField(value)`](#fn-geohashgridwithfield) + * [`fn withId(value)`](#fn-geohashgridwithid) + * [`fn withSettings(value)`](#fn-geohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) + * [`fn withType()`](#fn-geohashgridwithtype) + * [`obj settings`](#obj-geohashgridsettings) + * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) +* [`obj Histogram`](#obj-histogram) + * [`fn withField(value)`](#fn-histogramwithfield) + * [`fn withId(value)`](#fn-histogramwithid) + * [`fn withSettings(value)`](#fn-histogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) + * [`fn withType()`](#fn-histogramwithtype) + * [`obj settings`](#obj-histogramsettings) + * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) +* [`obj Nested`](#obj-nested) + * [`fn withField(value)`](#fn-nestedwithfield) + * [`fn withId(value)`](#fn-nestedwithid) + * [`fn withSettings(value)`](#fn-nestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) + * [`fn withType()`](#fn-nestedwithtype) +* [`obj Terms`](#obj-terms) + * [`fn withField(value)`](#fn-termswithfield) + * [`fn withId(value)`](#fn-termswithid) + * [`fn withSettings(value)`](#fn-termswithsettings) + * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) + * [`fn withType()`](#fn-termswithtype) + * [`obj settings`](#obj-termssettings) + * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-termssettingswithmissing) + * [`fn withOrder(value)`](#fn-termssettingswithorder) + * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) + * [`fn withSize(value)`](#fn-termssettingswithsize) + +## Fields + +### obj DateHistogram + + +#### fn DateHistogram.withField + +```jsonnet +DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withId + +```jsonnet +DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withSettings + +```jsonnet +DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withSettingsMixin + +```jsonnet +DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withType + +```jsonnet +DateHistogram.withType() +``` + + + +#### obj DateHistogram.settings + + +##### fn DateHistogram.settings.withInterval + +```jsonnet +DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withMinDocCount + +```jsonnet +DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withOffset + +```jsonnet +DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTimeZone + +```jsonnet +DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTrimEdges + +```jsonnet +DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Filters + + +#### fn Filters.withId + +```jsonnet +Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Filters.withSettings + +```jsonnet +Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withSettingsMixin + +```jsonnet +Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withType + +```jsonnet +Filters.withType() +``` + + + +#### obj Filters.settings + + +##### fn Filters.settings.withFilters + +```jsonnet +Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn Filters.settings.withFiltersMixin + +```jsonnet +Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj GeoHashGrid + + +#### fn GeoHashGrid.withField + +```jsonnet +GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withId + +```jsonnet +GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withSettings + +```jsonnet +GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withSettingsMixin + +```jsonnet +GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withType + +```jsonnet +GeoHashGrid.withType() +``` + + + +#### obj GeoHashGrid.settings + + +##### fn GeoHashGrid.settings.withPrecision + +```jsonnet +GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Histogram + + +#### fn Histogram.withField + +```jsonnet +Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withId + +```jsonnet +Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withSettings + +```jsonnet +Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withSettingsMixin + +```jsonnet +Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withType + +```jsonnet +Histogram.withType() +``` + + + +#### obj Histogram.settings + + +##### fn Histogram.settings.withInterval + +```jsonnet +Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Histogram.settings.withMinDocCount + +```jsonnet +Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Nested + + +#### fn Nested.withField + +```jsonnet +Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withId + +```jsonnet +Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withSettings + +```jsonnet +Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withSettingsMixin + +```jsonnet +Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withType + +```jsonnet +Nested.withType() +``` + + + +### obj Terms + + +#### fn Terms.withField + +```jsonnet +Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withId + +```jsonnet +Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withSettings + +```jsonnet +Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withSettingsMixin + +```jsonnet +Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withType + +```jsonnet +Terms.withType() +``` + + + +#### obj Terms.settings + + +##### fn Terms.settings.withMinDocCount + +```jsonnet +Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withMissing + +```jsonnet +Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withOrder + +```jsonnet +Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +##### fn Terms.settings.withOrderBy + +```jsonnet +Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withSize + +```jsonnet +Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md new file mode 100644 index 0000000..a84eb5f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/index.md @@ -0,0 +1,150 @@ +# elasticsearch + +grafonnet.query.elasticsearch + +## Subpackages + +* [bucketAggs](bucketAggs/index.md) +* [metrics](metrics/index.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withBucketAggs(value)`](#fn-withbucketaggs) +* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withMetrics(value)`](#fn-withmetrics) +* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTimeField(value)`](#fn-withtimefield) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alias pattern +### fn withBucketAggs + +```jsonnet +withBucketAggs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withBucketAggsMixin + +```jsonnet +withBucketAggsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withMetrics + +```jsonnet +withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withMetricsMixin + +```jsonnet +withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Lucene query +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTimeField + +```jsonnet +withTimeField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of time field \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md new file mode 100644 index 0000000..fc18efe --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/elasticsearch/metrics/index.md @@ -0,0 +1,2547 @@ +# metrics + + + +## Subpackages + +* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`obj Count`](#obj-count) + * [`fn withHide(value=true)`](#fn-countwithhide) + * [`fn withId(value)`](#fn-countwithid) + * [`fn withType()`](#fn-countwithtype) +* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) + * [`obj Average`](#obj-metricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) +* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) + * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### obj Count + + +#### fn Count.withHide + +```jsonnet +Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn Count.withId + +```jsonnet +Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Count.withType + +```jsonnet +Count.withType() +``` + + + +### obj MetricAggregationWithSettings + + +#### obj MetricAggregationWithSettings.Average + + +##### fn MetricAggregationWithSettings.Average.withField + +```jsonnet +MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withHide + +```jsonnet +MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Average.withId + +```jsonnet +MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withSettings + +```jsonnet +MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withType + +```jsonnet +MetricAggregationWithSettings.Average.withType() +``` + + + +##### obj MetricAggregationWithSettings.Average.settings + + +###### fn MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Average.settings.script + + +####### fn MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.BucketScript + + +##### fn MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +MetricAggregationWithSettings.BucketScript.withType() +``` + + + +##### obj MetricAggregationWithSettings.BucketScript.settings + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.BucketScript.settings.script + + +####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.CumulativeSum + + +##### fn MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +##### obj MetricAggregationWithSettings.CumulativeSum.settings + + +###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Derivative + + +##### fn MetricAggregationWithSettings.Derivative.withField + +```jsonnet +MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Derivative.withId + +```jsonnet +MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withType + +```jsonnet +MetricAggregationWithSettings.Derivative.withType() +``` + + + +##### obj MetricAggregationWithSettings.Derivative.settings + + +###### fn MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.ExtendedStats + + +##### fn MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +##### obj MetricAggregationWithSettings.ExtendedStats.settings + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.ExtendedStats.settings.script + + +####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Logs + + +##### fn MetricAggregationWithSettings.Logs.withHide + +```jsonnet +MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Logs.withId + +```jsonnet +MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withType + +```jsonnet +MetricAggregationWithSettings.Logs.withType() +``` + + + +##### obj MetricAggregationWithSettings.Logs.settings + + +###### fn MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Max + + +##### fn MetricAggregationWithSettings.Max.withField + +```jsonnet +MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withHide + +```jsonnet +MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Max.withId + +```jsonnet +MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withSettings + +```jsonnet +MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withType + +```jsonnet +MetricAggregationWithSettings.Max.withType() +``` + + + +##### obj MetricAggregationWithSettings.Max.settings + + +###### fn MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Max.settings.script + + +####### fn MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Min + + +##### fn MetricAggregationWithSettings.Min.withField + +```jsonnet +MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withHide + +```jsonnet +MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Min.withId + +```jsonnet +MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withSettings + +```jsonnet +MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withType + +```jsonnet +MetricAggregationWithSettings.Min.withType() +``` + + + +##### obj MetricAggregationWithSettings.Min.settings + + +###### fn MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Min.settings.script + + +####### fn MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingAverage + + +##### fn MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +#### obj MetricAggregationWithSettings.MovingFunction + + +##### fn MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +##### obj MetricAggregationWithSettings.MovingFunction.settings + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.MovingFunction.settings.script + + +####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Percentiles + + +##### fn MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +MetricAggregationWithSettings.Percentiles.withType() +``` + + + +##### obj MetricAggregationWithSettings.Percentiles.settings + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Percentiles.settings.script + + +####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Rate + + +##### fn MetricAggregationWithSettings.Rate.withField + +```jsonnet +MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withHide + +```jsonnet +MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Rate.withId + +```jsonnet +MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withType + +```jsonnet +MetricAggregationWithSettings.Rate.withType() +``` + + + +##### obj MetricAggregationWithSettings.Rate.settings + + +###### fn MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawData + + +##### fn MetricAggregationWithSettings.RawData.withHide + +```jsonnet +MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawData.withId + +```jsonnet +MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withType + +```jsonnet +MetricAggregationWithSettings.RawData.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawData.settings + + +###### fn MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawDocument + + +##### fn MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +MetricAggregationWithSettings.RawDocument.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawDocument.settings + + +###### fn MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.SerialDiff + + +##### fn MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +##### obj MetricAggregationWithSettings.SerialDiff.settings + + +###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Sum + + +##### fn MetricAggregationWithSettings.Sum.withField + +```jsonnet +MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withHide + +```jsonnet +MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Sum.withId + +```jsonnet +MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withType + +```jsonnet +MetricAggregationWithSettings.Sum.withType() +``` + + + +##### obj MetricAggregationWithSettings.Sum.settings + + +###### fn MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Sum.settings.script + + +####### fn MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.TopMetrics + + +##### fn MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +##### obj MetricAggregationWithSettings.TopMetrics.settings + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.UniqueCount + + +##### fn MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +##### obj MetricAggregationWithSettings.UniqueCount.settings + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj PipelineMetricAggregation + + +#### obj PipelineMetricAggregation.BucketScript + + +##### fn PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.BucketScript.withId + +```jsonnet +PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withType + +```jsonnet +PipelineMetricAggregation.BucketScript.withType() +``` + + + +##### obj PipelineMetricAggregation.BucketScript.settings + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj PipelineMetricAggregation.BucketScript.settings.script + + +####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.CumulativeSum + + +##### fn PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +##### obj PipelineMetricAggregation.CumulativeSum.settings + + +###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.Derivative + + +##### fn PipelineMetricAggregation.Derivative.withField + +```jsonnet +PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withHide + +```jsonnet +PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.Derivative.withId + +```jsonnet +PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withType + +```jsonnet +PipelineMetricAggregation.Derivative.withType() +``` + + + +##### obj PipelineMetricAggregation.Derivative.settings + + +###### fn PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.MovingAverage + + +##### fn PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md new file mode 100644 index 0000000..8ad0147 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/conditions.md @@ -0,0 +1,205 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withOperatorMixin(value)`](#fn-withoperatormixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryMixin(value)`](#fn-withquerymixin) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withReducerMixin(value)`](#fn-withreducermixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj operator`](#obj-operator) + * [`fn withType(value)`](#fn-operatorwithtype) +* [`obj query`](#obj-query) + * [`fn withParams(value)`](#fn-querywithparams) + * [`fn withParamsMixin(value)`](#fn-querywithparamsmixin) +* [`obj reducer`](#obj-reducer) + * [`fn withType(value)`](#fn-reducerwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperatorMixin + +```jsonnet +withOperatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryMixin + +```jsonnet +withQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducerMixin + +```jsonnet +withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +e.g. "gt" +### obj operator + + +#### fn operator.withType + +```jsonnet +operator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +### obj query + + +#### fn query.withParams + +```jsonnet +query.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn query.withParamsMixin + +```jsonnet +query.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj reducer + + +#### fn reducer.withType + +```jsonnet +reducer.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md new file mode 100644 index 0000000..e2b1f59 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeClassicConditions/index.md @@ -0,0 +1,324 @@ +# TypeClassicConditions + +grafonnet.query.expr.TypeClassicConditions + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md new file mode 100644 index 0000000..a8b85d2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeMath.md @@ -0,0 +1,308 @@ +# TypeMath + +grafonnet.query.expr.TypeMath + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +General math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md new file mode 100644 index 0000000..6ba5d52 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeReduce.md @@ -0,0 +1,384 @@ +# TypeReduce + +grafonnet.query.expr.TypeReduce + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj settings`](#obj-settings) + * [`fn withMode(value)`](#fn-settingswithmode) + * [`fn withReplaceWithValue(value)`](#fn-settingswithreplacewithvalue) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The reducer +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj settings + + +#### fn settings.withMode + +```jsonnet +settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"dropNN"`, `"replaceNN"` + +Non-number reduce behavior +Possible enum values: + - `"dropNN"` Drop non-numbers + - `"replaceNN"` Replace non-numbers +#### fn settings.withReplaceWithValue + +```jsonnet +settings.withReplaceWithValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Only valid when mode is replace +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md new file mode 100644 index 0000000..c1162c0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeResample.md @@ -0,0 +1,357 @@ +# TypeResample + +grafonnet.query.expr.TypeResample + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDownsampler(value)`](#fn-withdownsampler) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`fn withUpsampler(value)`](#fn-withupsampler) +* [`fn withWindow(value)`](#fn-withwindow) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDownsampler + +```jsonnet +withDownsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"` + +The downsample function +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### fn withUpsampler + +```jsonnet +withUpsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pad"`, `"backfilling"`, `"fillna"` + +The upsample function +Possible enum values: + - `"pad"` Use the last seen value + - `"backfilling"` backfill + - `"fillna"` Do not fill values (nill) +### fn withWindow + +```jsonnet +withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The time duration +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md new file mode 100644 index 0000000..f0a4639 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeSql.md @@ -0,0 +1,308 @@ +# TypeSql + +grafonnet.query.expr.TypeSql + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md new file mode 100644 index 0000000..554ddb9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/conditions.md @@ -0,0 +1,163 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withLoadedDimensions(value)`](#fn-withloadeddimensions) +* [`fn withLoadedDimensionsMixin(value)`](#fn-withloadeddimensionsmixin) +* [`fn withUnloadEvaluator(value)`](#fn-withunloadevaluator) +* [`fn withUnloadEvaluatorMixin(value)`](#fn-withunloadevaluatormixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj unloadEvaluator`](#obj-unloadevaluator) + * [`fn withParams(value)`](#fn-unloadevaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-unloadevaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-unloadevaluatorwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensions + +```jsonnet +withLoadedDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensionsMixin + +```jsonnet +withLoadedDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluator + +```jsonnet +withUnloadEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluatorMixin + +```jsonnet +withUnloadEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" +### obj unloadEvaluator + + +#### fn unloadEvaluator.withParams + +```jsonnet +unloadEvaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withParamsMixin + +```jsonnet +unloadEvaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withType + +```jsonnet +unloadEvaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md new file mode 100644 index 0000000..e2e47f1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/TypeThreshold/index.md @@ -0,0 +1,336 @@ +# TypeThreshold + +grafonnet.query.expr.TypeThreshold + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withApiVersion(value)`](#fn-datasourcewithapiversion) + * [`fn withType()`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The datasource +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withApiVersion + +```jsonnet +datasource.withApiVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The apiserver version +#### fn datasource.withType + +```jsonnet +datasource.withType() +``` + + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID (NOTE: name in k8s) +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/index.md new file mode 100644 index 0000000..a89a72a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/expr/index.md @@ -0,0 +1,12 @@ +# expr + +Server Side Expression operations for grafonnet.alerting.ruleGroup.rule + +## Subpackages + +* [TypeClassicConditions](TypeClassicConditions/index.md) +* [TypeMath](TypeMath.md) +* [TypeReduce](TypeReduce.md) +* [TypeResample](TypeResample.md) +* [TypeSql](TypeSql.md) +* [TypeThreshold](TypeThreshold/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md new file mode 100644 index 0000000..b728940 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/googleCloudMonitoring.md @@ -0,0 +1,595 @@ +# googleCloudMonitoring + +grafonnet.query.googleCloudMonitoring + +## Index + +* [`fn withAliasBy(value)`](#fn-withaliasby) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withPromQLQuery(value)`](#fn-withpromqlquery) +* [`fn withPromQLQueryMixin(value)`](#fn-withpromqlquerymixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSloQuery(value)`](#fn-withsloquery) +* [`fn withSloQueryMixin(value)`](#fn-withsloquerymixin) +* [`fn withTimeSeriesList(value)`](#fn-withtimeserieslist) +* [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) +* [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) +* [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj promQLQuery`](#obj-promqlquery) + * [`fn withExpr(value)`](#fn-promqlquerywithexpr) + * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) + * [`fn withStep(value)`](#fn-promqlquerywithstep) +* [`obj sloQuery`](#obj-sloquery) + * [`fn withAlignmentPeriod(value)`](#fn-sloquerywithalignmentperiod) + * [`fn withGoal(value)`](#fn-sloquerywithgoal) + * [`fn withLookbackPeriod(value)`](#fn-sloquerywithlookbackperiod) + * [`fn withPerSeriesAligner(value)`](#fn-sloquerywithperseriesaligner) + * [`fn withProjectName(value)`](#fn-sloquerywithprojectname) + * [`fn withSelectorName(value)`](#fn-sloquerywithselectorname) + * [`fn withServiceId(value)`](#fn-sloquerywithserviceid) + * [`fn withServiceName(value)`](#fn-sloquerywithservicename) + * [`fn withSloId(value)`](#fn-sloquerywithsloid) + * [`fn withSloName(value)`](#fn-sloquerywithsloname) +* [`obj timeSeriesList`](#obj-timeserieslist) + * [`fn withAlignmentPeriod(value)`](#fn-timeserieslistwithalignmentperiod) + * [`fn withCrossSeriesReducer(value)`](#fn-timeserieslistwithcrossseriesreducer) + * [`fn withFilters(value)`](#fn-timeserieslistwithfilters) + * [`fn withFiltersMixin(value)`](#fn-timeserieslistwithfiltersmixin) + * [`fn withGroupBys(value)`](#fn-timeserieslistwithgroupbys) + * [`fn withGroupBysMixin(value)`](#fn-timeserieslistwithgroupbysmixin) + * [`fn withPerSeriesAligner(value)`](#fn-timeserieslistwithperseriesaligner) + * [`fn withPreprocessor(value)`](#fn-timeserieslistwithpreprocessor) + * [`fn withProjectName(value)`](#fn-timeserieslistwithprojectname) + * [`fn withSecondaryAlignmentPeriod(value)`](#fn-timeserieslistwithsecondaryalignmentperiod) + * [`fn withSecondaryCrossSeriesReducer(value)`](#fn-timeserieslistwithsecondarycrossseriesreducer) + * [`fn withSecondaryGroupBys(value)`](#fn-timeserieslistwithsecondarygroupbys) + * [`fn withSecondaryGroupBysMixin(value)`](#fn-timeserieslistwithsecondarygroupbysmixin) + * [`fn withSecondaryPerSeriesAligner(value)`](#fn-timeserieslistwithsecondaryperseriesaligner) + * [`fn withText(value)`](#fn-timeserieslistwithtext) + * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) + * [`fn withView(value)`](#fn-timeserieslistwithview) +* [`obj timeSeriesQuery`](#obj-timeseriesquery) + * [`fn withGraphPeriod(value="disabled")`](#fn-timeseriesquerywithgraphperiod) + * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) + * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) + +## Fields + +### fn withAliasBy + +```jsonnet +withAliasBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Time interval in milliseconds. +### fn withPromQLQuery + +```jsonnet +withPromQLQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withPromQLQueryMixin + +```jsonnet +withPromQLQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSloQuery + +```jsonnet +withSloQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withSloQueryMixin + +```jsonnet +withSloQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withTimeSeriesList + +```jsonnet +withTimeSeriesList(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesListMixin + +```jsonnet +withTimeSeriesListMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesQuery + +```jsonnet +withTimeSeriesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### fn withTimeSeriesQueryMixin + +```jsonnet +withTimeSeriesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### obj promQLQuery + + +#### fn promQLQuery.withExpr + +```jsonnet +promQLQuery.withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL expression/query to be executed. +#### fn promQLQuery.withProjectName + +```jsonnet +promQLQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn promQLQuery.withStep + +```jsonnet +promQLQuery.withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL min step +### obj sloQuery + + +#### fn sloQuery.withAlignmentPeriod + +```jsonnet +sloQuery.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn sloQuery.withGoal + +```jsonnet +sloQuery.withGoal(value) +``` + +PARAMETERS: + +* **value** (`number`) + +SLO goal value. +#### fn sloQuery.withLookbackPeriod + +```jsonnet +sloQuery.withLookbackPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific lookback period for the SLO. +#### fn sloQuery.withPerSeriesAligner + +```jsonnet +sloQuery.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn sloQuery.withProjectName + +```jsonnet +sloQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn sloQuery.withSelectorName + +```jsonnet +sloQuery.withSelectorName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +SLO selector. +#### fn sloQuery.withServiceId + +```jsonnet +sloQuery.withServiceId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the service the SLO is in. +#### fn sloQuery.withServiceName + +```jsonnet +sloQuery.withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name for the service the SLO is in. +#### fn sloQuery.withSloId + +```jsonnet +sloQuery.withSloId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the SLO. +#### fn sloQuery.withSloName + +```jsonnet +sloQuery.withSloName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the SLO. +### obj timeSeriesList + + +#### fn timeSeriesList.withAlignmentPeriod + +```jsonnet +timeSeriesList.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withCrossSeriesReducer + +```jsonnet +timeSeriesList.withCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withFilters + +```jsonnet +timeSeriesList.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withFiltersMixin + +```jsonnet +timeSeriesList.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withGroupBys + +```jsonnet +timeSeriesList.withGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withGroupBysMixin + +```jsonnet +timeSeriesList.withGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withPerSeriesAligner + +```jsonnet +timeSeriesList.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withPreprocessor + +```jsonnet +timeSeriesList.withPreprocessor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"rate"`, `"delta"` + +Types of pre-processor available. Defined by the metric. +#### fn timeSeriesList.withProjectName + +```jsonnet +timeSeriesList.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesList.withSecondaryAlignmentPeriod + +```jsonnet +timeSeriesList.withSecondaryAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withSecondaryCrossSeriesReducer + +```jsonnet +timeSeriesList.withSecondaryCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withSecondaryGroupBys + +```jsonnet +timeSeriesList.withSecondaryGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryGroupBysMixin + +```jsonnet +timeSeriesList.withSecondaryGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryPerSeriesAligner + +```jsonnet +timeSeriesList.withSecondaryPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withText + +```jsonnet +timeSeriesList.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation text. +#### fn timeSeriesList.withTitle + +```jsonnet +timeSeriesList.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation title. +#### fn timeSeriesList.withView + +```jsonnet +timeSeriesList.withView(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Data view, defaults to FULL. +### obj timeSeriesQuery + + +#### fn timeSeriesQuery.withGraphPeriod + +```jsonnet +timeSeriesQuery.withGraphPeriod(value="disabled") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"disabled"` + +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withProjectName + +```jsonnet +timeSeriesQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesQuery.withQuery + +```jsonnet +timeSeriesQuery.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +MQL query to be executed. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md new file mode 100644 index 0000000..c150bba --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/grafanaPyroscope.md @@ -0,0 +1,146 @@ +# grafanaPyroscope + +grafonnet.query.grafanaPyroscope + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withMaxNodes(value)`](#fn-withmaxnodes) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSpanSelector(value)`](#fn-withspanselector) +* [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Allows to group the results. +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Allows to group the results. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. +### fn withMaxNodes + +```jsonnet +withMaxNodes(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the maximum number of nodes in the flamegraph. +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the type of profile to query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSpanSelector + +```jsonnet +withSpanSelector(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Specifies the query span selectors. +### fn withSpanSelectorMixin + +```jsonnet +withSpanSelectorMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Specifies the query span selectors. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/index.md new file mode 100644 index 0000000..2e38197 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/index.md @@ -0,0 +1,17 @@ +# query + +grafonnet.query + +## Subpackages + +* [azureMonitor](azureMonitor/index.md) +* [cloudWatch](cloudWatch/index.md) +* [elasticsearch](elasticsearch/index.md) +* [expr](expr/index.md) +* [googleCloudMonitoring](googleCloudMonitoring.md) +* [grafanaPyroscope](grafanaPyroscope.md) +* [loki](loki.md) +* [parca](parca.md) +* [prometheus](prometheus.md) +* [tempo](tempo/index.md) +* [testData](testData/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/loki.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/loki.md new file mode 100644 index 0000000..2ebd28f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/loki.md @@ -0,0 +1,173 @@ +# loki + +grafonnet.query.loki + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withMaxLines(value)`](#fn-withmaxlines) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResolution(value)`](#fn-withresolution) +* [`fn withStep(value)`](#fn-withstep) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new loki query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The LogQL query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated, now use queryType. +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used to override the name of the series. +### fn withMaxLines + +```jsonnet +withMaxLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Used to limit the number of log rows returned. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated, now use queryType. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withResolution + +```jsonnet +withResolution(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +@deprecated, now use step. +### fn withStep + +```jsonnet +withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used to set step value for range queries. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/parca.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/parca.md new file mode 100644 index 0000000..03c73bf --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/parca.md @@ -0,0 +1,86 @@ +# parca + +grafonnet.query.parca + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the type of profile to query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/prometheus.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/prometheus.md new file mode 100644 index 0000000..df1b146 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/prometheus.md @@ -0,0 +1,188 @@ +# prometheus + +grafonnet.query.prometheus + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExemplar(value=true)`](#fn-withexemplar) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withIntervalFactor(value)`](#fn-withintervalfactor) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new prometheus query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withExemplar + +```jsonnet +withExemplar(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Execute an additional query to identify interesting raw samples relevant for the given expr +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The actual expression/query that will be evaluated by Prometheus +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"time_series"`, `"table"`, `"heatmap"` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Returns only the latest value that Prometheus has scraped for the requested time series +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An additional lower limit for the step parameter of the Prometheus query and for the +`$__interval` and `$__rate_interval` variables. +### fn withIntervalFactor + +```jsonnet +withIntervalFactor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the interval factor for this query. +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the legend format for this query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md new file mode 100644 index 0000000..4482fd2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/filters.md @@ -0,0 +1,94 @@ +# filters + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md new file mode 100644 index 0000000..795b78e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/groupBy.md @@ -0,0 +1,94 @@ +# groupBy + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/index.md new file mode 100644 index 0000000..485ab22 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/tempo/index.md @@ -0,0 +1,274 @@ +# tempo + +grafonnet.query.tempo + +## Subpackages + +* [filters](filters.md) +* [groupBy](groupBy.md) + +## Index + +* [`fn new(datasource, query, filters)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLimit(value)`](#fn-withlimit) +* [`fn withMaxDuration(value)`](#fn-withmaxduration) +* [`fn withMinDuration(value)`](#fn-withminduration) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSearch(value)`](#fn-withsearch) +* [`fn withServiceMapIncludeNamespace(value=true)`](#fn-withservicemapincludenamespace) +* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) +* [`fn withServiceMapQueryMixin(value)`](#fn-withservicemapquerymixin) +* [`fn withServiceName(value)`](#fn-withservicename) +* [`fn withSpanName(value)`](#fn-withspanname) +* [`fn withSpss(value)`](#fn-withspss) +* [`fn withTableType(value)`](#fn-withtabletype) + +## Fields + +### fn new + +```jsonnet +new(datasource, query, filters) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **query** (`string`) +* **filters** (`array`) + +Creates a new tempo query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLimit + +```jsonnet +withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of traces that are returned from Tempo +### fn withMaxDuration + +```jsonnet +withMaxDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withMinDuration + +```jsonnet +withMinDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TraceQL query or trace ID +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSearch + +```jsonnet +withSearch(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true +### fn withServiceMapIncludeNamespace + +```jsonnet +withServiceMapIncludeNamespace(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Use service.namespace in addition to service.name to uniquely identify a service. +### fn withServiceMapQuery + +```jsonnet +withServiceMapQuery(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceMapQueryMixin + +```jsonnet +withServiceMapQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceName + +```jsonnet +withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by service name +### fn withSpanName + +```jsonnet +withSpanName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by span name +### fn withSpss + +```jsonnet +withSpss(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of spans per spanset that are returned from Tempo +### fn withTableType + +```jsonnet +withTableType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"traces"`, `"spans"` + +The type of the table that is used to display the search results \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md new file mode 100644 index 0000000..8927e1c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/csvWave.md @@ -0,0 +1,56 @@ +# csvWave + + + +## Index + +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeStep(value)`](#fn-withtimestep) +* [`fn withValuesCSV(value)`](#fn-withvaluescsv) + +## Fields + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeStep + +```jsonnet +withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withValuesCSV + +```jsonnet +withValuesCSV(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/index.md new file mode 100644 index 0000000..f1c8828 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/query/testData/index.md @@ -0,0 +1,1107 @@ +# testData + +grafonnet.query.testData + +## Subpackages + +* [csvWave](csvWave.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withChannel(value)`](#fn-withchannel) +* [`fn withCsvContent(value)`](#fn-withcsvcontent) +* [`fn withCsvFileName(value)`](#fn-withcsvfilename) +* [`fn withCsvWave(value)`](#fn-withcsvwave) +* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDropPercent(value)`](#fn-withdroppercent) +* [`fn withErrorType(value)`](#fn-witherrortype) +* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) +* [`fn withLines(value)`](#fn-withlines) +* [`fn withMax(value)`](#fn-withmax) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withMin(value)`](#fn-withmin) +* [`fn withNodes(value)`](#fn-withnodes) +* [`fn withNodesMixin(value)`](#fn-withnodesmixin) +* [`fn withNoise(value)`](#fn-withnoise) +* [`fn withPoints(value)`](#fn-withpoints) +* [`fn withPointsMixin(value)`](#fn-withpointsmixin) +* [`fn withPulseWave(value)`](#fn-withpulsewave) +* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withScenarioId(value)`](#fn-withscenarioid) +* [`fn withSeriesCount(value)`](#fn-withseriescount) +* [`fn withSim(value)`](#fn-withsim) +* [`fn withSimMixin(value)`](#fn-withsimmixin) +* [`fn withSpanCount(value)`](#fn-withspancount) +* [`fn withSpread(value)`](#fn-withspread) +* [`fn withStartValue(value)`](#fn-withstartvalue) +* [`fn withStream(value)`](#fn-withstream) +* [`fn withStreamMixin(value)`](#fn-withstreammixin) +* [`fn withStringInput(value)`](#fn-withstringinput) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withUsa(value)`](#fn-withusa) +* [`fn withUsaMixin(value)`](#fn-withusamixin) +* [`fn withWithNil(value=true)`](#fn-withwithnil) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj nodes`](#obj-nodes) + * [`fn withCount(value)`](#fn-nodeswithcount) + * [`fn withSeed(value)`](#fn-nodeswithseed) + * [`fn withType(value)`](#fn-nodeswithtype) +* [`obj pulseWave`](#obj-pulsewave) + * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) + * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) + * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) + * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) + * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj sim`](#obj-sim) + * [`fn withConfig(value)`](#fn-simwithconfig) + * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) + * [`fn withKey(value)`](#fn-simwithkey) + * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) + * [`fn withLast(value=true)`](#fn-simwithlast) + * [`fn withStream(value=true)`](#fn-simwithstream) + * [`obj key`](#obj-simkey) + * [`fn withTick(value)`](#fn-simkeywithtick) + * [`fn withType(value)`](#fn-simkeywithtype) + * [`fn withUid(value)`](#fn-simkeywithuid) +* [`obj stream`](#obj-stream) + * [`fn withBands(value)`](#fn-streamwithbands) + * [`fn withNoise(value)`](#fn-streamwithnoise) + * [`fn withSpeed(value)`](#fn-streamwithspeed) + * [`fn withSpread(value)`](#fn-streamwithspread) + * [`fn withType(value)`](#fn-streamwithtype) + * [`fn withUrl(value)`](#fn-streamwithurl) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) +* [`obj usa`](#obj-usa) + * [`fn withFields(value)`](#fn-usawithfields) + * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) + * [`fn withMode(value)`](#fn-usawithmode) + * [`fn withPeriod(value)`](#fn-usawithperiod) + * [`fn withStates(value)`](#fn-usawithstates) + * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withChannel + +```jsonnet +withChannel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used for live query +### fn withCsvContent + +```jsonnet +withCsvContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvFileName + +```jsonnet +withCsvFileName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvWave + +```jsonnet +withCsvWave(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withCsvWaveMixin + +```jsonnet +withCsvWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withDropPercent + +```jsonnet +withDropPercent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Drop percentage (the chance we will lose a point 0-100) +### fn withErrorType + +```jsonnet +withErrorType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"frontend_exception"`, `"frontend_observable"`, `"server_panic"` + +Possible enum values: + - `"frontend_exception"` + - `"frontend_observable"` + - `"server_panic"` +### fn withFlamegraphDiff + +```jsonnet +withFlamegraphDiff(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withLevelColumn + +```jsonnet +withLevelColumn(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLines + +```jsonnet +withLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withMax + +```jsonnet +withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withMin + +```jsonnet +withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withNodes + +```jsonnet +withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNodesMixin + +```jsonnet +withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNoise + +```jsonnet +withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withPoints + +```jsonnet +withPoints(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPointsMixin + +```jsonnet +withPointsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPulseWave + +```jsonnet +withPulseWave(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPulseWaveMixin + +```jsonnet +withPulseWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRawFrameContent + +```jsonnet +withRawFrameContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScenarioId + +```jsonnet +withScenarioId(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"annotations"`, `"arrow"`, `"csv_content"`, `"csv_file"`, `"csv_metric_values"`, `"datapoints_outside_range"`, `"exponential_heatmap_bucket_data"`, `"flame_graph"`, `"grafana_api"`, `"linear_heatmap_bucket_data"`, `"live"`, `"logs"`, `"manual_entry"`, `"no_data_points"`, `"node_graph"`, `"predictable_csv_wave"`, `"predictable_pulse"`, `"random_walk"`, `"random_walk_table"`, `"random_walk_with_error"`, `"raw_frame"`, `"server_error_500"`, `"simulation"`, `"slow_query"`, `"streaming_client"`, `"table_static"`, `"trace"`, `"usa"`, `"variables-query"` + +Possible enum values: + - `"annotations"` + - `"arrow"` + - `"csv_content"` + - `"csv_file"` + - `"csv_metric_values"` + - `"datapoints_outside_range"` + - `"exponential_heatmap_bucket_data"` + - `"flame_graph"` + - `"grafana_api"` + - `"linear_heatmap_bucket_data"` + - `"live"` + - `"logs"` + - `"manual_entry"` + - `"no_data_points"` + - `"node_graph"` + - `"predictable_csv_wave"` + - `"predictable_pulse"` + - `"random_walk"` + - `"random_walk_table"` + - `"random_walk_with_error"` + - `"raw_frame"` + - `"server_error_500"` + - `"simulation"` + - `"slow_query"` + - `"streaming_client"` + - `"table_static"` + - `"trace"` + - `"usa"` + - `"variables-query"` +### fn withSeriesCount + +```jsonnet +withSeriesCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSim + +```jsonnet +withSim(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSimMixin + +```jsonnet +withSimMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSpanCount + +```jsonnet +withSpanCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSpread + +```jsonnet +withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStartValue + +```jsonnet +withStartValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStream + +```jsonnet +withStream(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStreamMixin + +```jsonnet +withStreamMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStringInput + +```jsonnet +withStringInput(value) +``` + +PARAMETERS: + +* **value** (`string`) + +common parameter used by many query types +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsa + +```jsonnet +withUsa(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsaMixin + +```jsonnet +withUsaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withWithNil + +```jsonnet +withWithNil(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The datasource plugin type +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Datasource UID +### obj nodes + + +#### fn nodes.withCount + +```jsonnet +nodes.withCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withSeed + +```jsonnet +nodes.withSeed(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withType + +```jsonnet +nodes.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"random"`, `"random edges"`, `"response_medium"`, `"response_small"`, `"feature_showcase"` + +Possible enum values: + - `"random"` + - `"random edges"` + - `"response_medium"` + - `"response_small"` + - `"feature_showcase"` +### obj pulseWave + + +#### fn pulseWave.withOffCount + +```jsonnet +pulseWave.withOffCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOffValue + +```jsonnet +pulseWave.withOffValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withOnCount + +```jsonnet +pulseWave.withOnCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOnValue + +```jsonnet +pulseWave.withOnValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withTimeStep + +```jsonnet +pulseWave.withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj sim + + +#### fn sim.withConfig + +```jsonnet +sim.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withConfigMixin + +```jsonnet +sim.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKey + +```jsonnet +sim.withKey(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKeyMixin + +```jsonnet +sim.withKeyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withLast + +```jsonnet +sim.withLast(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn sim.withStream + +```jsonnet +sim.withStream(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj sim.key + + +##### fn sim.key.withTick + +```jsonnet +sim.key.withTick(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn sim.key.withType + +```jsonnet +sim.key.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn sim.key.withUid + +```jsonnet +sim.key.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj stream + + +#### fn stream.withBands + +```jsonnet +stream.withBands(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn stream.withNoise + +```jsonnet +stream.withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpeed + +```jsonnet +stream.withSpeed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpread + +```jsonnet +stream.withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withType + +```jsonnet +stream.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fetch"`, `"logs"`, `"signal"`, `"traces"` + +Possible enum values: + - `"fetch"` + - `"logs"` + - `"signal"` + - `"traces"` +#### fn stream.withUrl + +```jsonnet +stream.withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. +### obj usa + + +#### fn usa.withFields + +```jsonnet +usa.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withFieldsMixin + +```jsonnet +usa.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withMode + +```jsonnet +usa.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withPeriod + +```jsonnet +usa.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withStates + +```jsonnet +usa.withStates(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withStatesMixin + +```jsonnet +usa.withStatesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/role.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/role.md new file mode 100644 index 0000000..b5b551c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/role.md @@ -0,0 +1,70 @@ +# role + +grafonnet.role + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withDisplayName(value)`](#fn-withdisplayname) +* [`fn withGroupName(value)`](#fn-withgroupname) +* [`fn withHidden(value=true)`](#fn-withhidden) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Role description +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display +### fn withGroupName + +```jsonnet +withGroupName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. +### fn withHidden + +```jsonnet +withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Do not show this role +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The role identifier `managed:builtins:editor:permissions` \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/rolebinding.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/rolebinding.md new file mode 100644 index 0000000..9a1e904 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/rolebinding.md @@ -0,0 +1,189 @@ +# rolebinding + +grafonnet.rolebinding + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withSubject(value)`](#fn-withsubject) +* [`fn withSubjectMixin(value)`](#fn-withsubjectmixin) +* [`obj role`](#obj-role) + * [`fn withBuiltinRoleRef(value)`](#fn-rolewithbuiltinroleref) + * [`fn withBuiltinRoleRefMixin(value)`](#fn-rolewithbuiltinrolerefmixin) + * [`fn withCustomRoleRef(value)`](#fn-rolewithcustomroleref) + * [`fn withCustomRoleRefMixin(value)`](#fn-rolewithcustomrolerefmixin) + * [`obj BuiltinRoleRef`](#obj-rolebuiltinroleref) + * [`fn withKind()`](#fn-rolebuiltinrolerefwithkind) + * [`fn withName(value)`](#fn-rolebuiltinrolerefwithname) + * [`obj CustomRoleRef`](#obj-rolecustomroleref) + * [`fn withKind()`](#fn-rolecustomrolerefwithkind) + * [`fn withName(value)`](#fn-rolecustomrolerefwithname) +* [`obj subject`](#obj-subject) + * [`fn withKind(value)`](#fn-subjectwithkind) + * [`fn withName(value)`](#fn-subjectwithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withSubject + +```jsonnet +withSubject(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSubjectMixin + +```jsonnet +withSubjectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj role + + +#### fn role.withBuiltinRoleRef + +```jsonnet +role.withBuiltinRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withBuiltinRoleRefMixin + +```jsonnet +role.withBuiltinRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRef + +```jsonnet +role.withCustomRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRefMixin + +```jsonnet +role.withCustomRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj role.BuiltinRoleRef + + +##### fn role.BuiltinRoleRef.withKind + +```jsonnet +role.BuiltinRoleRef.withKind() +``` + + + +##### fn role.BuiltinRoleRef.withName + +```jsonnet +role.BuiltinRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"viewer"`, `"editor"`, `"admin"` + + +#### obj role.CustomRoleRef + + +##### fn role.CustomRoleRef.withKind + +```jsonnet +role.CustomRoleRef.withKind() +``` + + + +##### fn role.CustomRoleRef.withName + +```jsonnet +role.CustomRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj subject + + +#### fn subject.withKind + +```jsonnet +subject.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Team"`, `"User"` + + +#### fn subject.withName + +```jsonnet +subject.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The team/user identifier name \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/team.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/team.md new file mode 100644 index 0000000..cce602b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/team.md @@ -0,0 +1,33 @@ +# team + +grafonnet.team + +## Index + +* [`fn withEmail(value)`](#fn-withemail) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withEmail + +```jsonnet +withEmail(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Email of the team. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/util.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/util.md new file mode 100644 index 0000000..af88a40 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/docs/util.md @@ -0,0 +1,328 @@ +# util + +Helper functions that work well with Grafonnet. + +## Index + +* [`obj dashboard`](#obj-dashboard) + * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) +* [`obj grid`](#obj-grid) + * [`fn makeGrid(panels, panelWidth, panelHeight, startY)`](#fn-gridmakegrid) + * [`fn wrapPanels(panels, panelWidth, panelHeight, startY)`](#fn-gridwrappanels) +* [`obj panel`](#obj-panel) + * [`fn calculateLowestYforPanel(panel, panels)`](#fn-panelcalculatelowestyforpanel) + * [`fn dedupeQueryTargets(panels)`](#fn-paneldedupequerytargets) + * [`fn getPanelIDs(panels)`](#fn-panelgetpanelids) + * [`fn getPanelsBeforeNextRow(panels)`](#fn-panelgetpanelsbeforenextrow) + * [`fn groupPanelsInRows(panels)`](#fn-panelgrouppanelsinrows) + * [`fn mapToRows(func, panels)`](#fn-panelmaptorows) + * [`fn normalizeY(panels)`](#fn-panelnormalizey) + * [`fn normalizeYInRow(rowPanel)`](#fn-panelnormalizeyinrow) + * [`fn resolveCollapsedFlagOnRows(panels)`](#fn-panelresolvecollapsedflagonrows) + * [`fn sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8)`](#fn-panelsanitizepanel) + * [`fn setPanelIDs(panels, overrideExistingIDs=true)`](#fn-panelsetpanelids) + * [`fn setRefIDs(panel, overrideExistingIDs=true)`](#fn-panelsetrefids) + * [`fn setRefIDsOnPanels(panels)`](#fn-panelsetrefidsonpanels) + * [`fn sortPanelsByXY(panels)`](#fn-panelsortpanelsbyxy) + * [`fn sortPanelsInRow(rowPanel)`](#fn-panelsortpanelsinrow) + * [`fn validatePanelIDs(panels)`](#fn-panelvalidatepanelids) +* [`obj string`](#obj-string) + * [`fn slugify(string)`](#fn-stringslugify) + +## Fields + +### obj dashboard + + +#### fn dashboard.getOptionsForCustomQuery + +```jsonnet +dashboard.getOptionsForCustomQuery(query) +``` + +PARAMETERS: + +* **query** (`string`) + +`getOptionsForCustomQuery` provides values for the `options` and `current` fields. +These are required for template variables of type 'custom'but do not automatically +get populated by Grafana when importing a dashboard from JSON. + +This is a bit of a hack and should always be called on functions that set `type` on +a template variable. Ideally Grafana populates these fields from the `query` value +but this provides a backwards compatible solution. + +### obj grid + + +#### fn grid.makeGrid + +```jsonnet +grid.makeGrid(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` +and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, +then all panels below it will be folded into the row. + +This function will use the full grid of 24 columns, setting `panelWidth` to a value +that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) +Other value for `panelWidth` will leave a gap on the far right. + +Optional `startY` can be provided to place generated grid above or below existing panels. + +#### fn grid.wrapPanels + +```jsonnet +grid.wrapPanels(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. +'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + +### obj panel + + +#### fn panel.calculateLowestYforPanel + +```jsonnet +panel.calculateLowestYforPanel(panel, panels) +``` + +PARAMETERS: + +* **panel** (`object`) +* **panels** (`array`) + +`calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + +#### fn panel.dedupeQueryTargets + +```jsonnet +panel.dedupeQueryTargets(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`dedupeQueryTargets` dedupes the query targets in a set of panels and replaces the duplicates with a ['shared query'](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/share-query/). Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard. + +This function requires that the query targets have `refId` set, `setRefIDs` and `setRefIDsOnPanels` can help with that. + +#### fn panel.getPanelIDs + +```jsonnet +panel.getPanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + +#### fn panel.getPanelsBeforeNextRow + +```jsonnet +panel.getPanelsBeforeNextRow(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + +#### fn panel.groupPanelsInRows + +```jsonnet +panel.groupPanelsInRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.mapToRows + +```jsonnet +panel.mapToRows(func, panels) +``` + +PARAMETERS: + +* **func** (`function`) +* **panels** (`array`) + +`mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + +#### fn panel.normalizeY + +```jsonnet +panel.normalizeY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + +This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + +#### fn panel.normalizeYInRow + +```jsonnet +panel.normalizeYInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`normalizeYInRow` applies `normalizeY` to the panels in a row panel. + +#### fn panel.resolveCollapsedFlagOnRows + +```jsonnet +panel.resolveCollapsedFlagOnRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.sanitizePanel + +```jsonnet +panel.sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8) +``` + +PARAMETERS: + +* **panel** (`object`) +* **defaultX** (`number`) + - default value: `0` +* **defaultY** (`number`) + - default value: `0` +* **defaultHeight** (`number`) + - default value: `8` +* **defaultWidth** (`number`) + - default value: `8` + +`sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + +The default values for x,y,h,w are only applied if not already set. + +#### fn panel.setPanelIDs + +```jsonnet +panel.setPanelIDs(panels, overrideExistingIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **overrideExistingIDs** (`bool`) + - default value: `true` + +`setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + +`overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + +#### fn panel.setRefIDs + +```jsonnet +panel.setRefIDs(panel, overrideExistingIDs=true) +``` + +PARAMETERS: + +* **panel** (`object`) +* **overrideExistingIDs** (`bool`) + - default value: `true` + +`setRefIDs` calculates the `refId` field for each target on a panel. + +#### fn panel.setRefIDsOnPanels + +```jsonnet +panel.setRefIDsOnPanels(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`setRefIDsOnPanels` applies `setRefIDs on all `panels`. + +#### fn panel.sortPanelsByXY + +```jsonnet +panel.sortPanelsByXY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + +#### fn panel.sortPanelsInRow + +```jsonnet +panel.sortPanelsInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + +#### fn panel.validatePanelIDs + +```jsonnet +panel.validatePanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + +### obj string + + +#### fn string.slugify + +```jsonnet +string.slugify(string) +``` + +PARAMETERS: + +* **string** (`string`) + +`slugify` will create a simple slug from `string`, keeping only alphanumeric +characters and replacing spaces with dashes. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/folder.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/folder.libsonnet new file mode 100644 index 0000000..e462d48 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/folder.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.folder', name: 'folder' }, + '#withParentUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'only used if nested folders are enabled' } }, + withParentUid(value): { + parentUid: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder title' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique folder id' } }, + withUid(value): { + uid: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/jsonnetfile.json b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/jsonnetfile.json new file mode 100644 index 0000000..8479d5a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/jsonnetfile.json @@ -0,0 +1,24 @@ +{ + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/docsonnet.git", + "subdir": "doc-util" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "master" + } + ], + "legacyImports": true, + "version": 1 +} \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/librarypanel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/librarypanel.libsonnet new file mode 100644 index 0000000..6182588 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/librarypanel.libsonnet @@ -0,0 +1,1130 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.librarypanel', name: 'librarypanel' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description' } }, + withDescription(value): { + description: value, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder UID' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { + meta+: value, + }, + meta+: + { + '#withConnectedDashboards': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withConnectedDashboards(value): { + meta+: { + connectedDashboards: value, + }, + }, + '#withCreated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCreated(value): { + meta+: { + created: value, + }, + }, + '#withCreatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedBy(value): { + meta+: { + createdBy: value, + }, + }, + '#withCreatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedByMixin(value): { + meta+: { + createdBy+: value, + }, + }, + createdBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + createdBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + createdBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + createdBy+: { + name: value, + }, + }, + }, + }, + '#withFolderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderName(value): { + meta+: { + folderName: value, + }, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + meta+: { + folderUid: value, + }, + }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { + meta+: { + updated: value, + }, + }, + '#withUpdatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedBy(value): { + meta+: { + updatedBy: value, + }, + }, + '#withUpdatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedByMixin(value): { + meta+: { + updatedBy+: value, + }, + }, + updatedBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + updatedBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + updatedBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + updatedBy+: { + name: value, + }, + }, + }, + }, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: "TODO: should be the same panel schema defined in dashboard\nTypescript: Omit;" } }, + withModelMixin(value): { + model+: value, + }, + model+: + { + '#withCacheTimeout': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets panel queries cache timeout.' } }, + withCacheTimeout(value): { + model+: { + cacheTimeout: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + model+: { + datasource: value, + }, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + model+: { + datasource+: value, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + model+: { + datasource+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + model+: { + datasource+: { + uid: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + model+: { + description: value, + }, + }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfig(value): { + model+: { + fieldConfig: value, + }, + }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfigMixin(value): { + model+: { + fieldConfig+: value, + }, + }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaults(value): { + model+: { + fieldConfig+: { + defaults: value, + }, + }, + }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaultsMixin(value): { + model+: { + fieldConfig+: { + defaults+: value, + }, + }, + }, + defaults+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color: value, + }, + }, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColorMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: value, + }, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + }, + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustom(value): { + model+: { + fieldConfig+: { + defaults+: { + custom: value, + }, + }, + }, + }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustomMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + custom+: value, + }, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + model+: { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Human readable field metadata' } }, + withDescription(value): { + model+: { + fieldConfig+: { + defaults+: { + description: value, + }, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + model+: { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + }, + '#withDisplayNameFromDS': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.' } }, + withDisplayNameFromDS(value): { + model+: { + fieldConfig+: { + defaults+: { + displayNameFromDS: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + model+: { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + mappings+: + { + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + model+: { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + model+: { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + model+: { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + model+: { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + }, + '#withThresholds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholds(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds: value, + }, + }, + }, + }, + '#withThresholdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholdsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: value, + }, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + steps+: + { + '#': { help: '', name: 'steps' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + model+: { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + }, + '#withWriteable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source can write a value to the path. Auth/authz are supported separately' } }, + withWriteable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + writeable: value, + }, + }, + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + model+: { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + model+: { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + overrides+: + { + '#': { help: '', name: 'overrides' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { + model+: { + hideTimeOverride: value, + }, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + model+: { + interval: value, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + model+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + model+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + model+: { + maxDataPoints: value, + }, + }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { + model+: { + maxPerRow: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptions(value): { + model+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptionsMixin(value): { + model+: { + options+: value, + }, + }, + '#withPluginVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.' } }, + withPluginVersion(value): { + model+: { + pluginVersion: value, + }, + }, + '#withQueryCachingTTL': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Overrides the data source configured time-to-live for a query cache item in milliseconds' } }, + withQueryCachingTTL(value): { + model+: { + queryCachingTTL: value, + }, + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + model+: { + repeat: value, + }, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + model+: { + repeatDirection: value, + }, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + model+: { + targets: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + model+: { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + model+: { + timeFrom: value, + }, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + model+: { + timeShift: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + model+: { + title: value, + }, + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + model+: { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + model+: { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + }, + transformations+: + { + '#': { help: '', name: 'transformations' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + model+: { + transparent: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + model+: { + type: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel name (also saved in the model)' } }, + withName(value): { + name: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Dashboard version when this was saved (zero if unknown)' } }, + withSchemaVersion(value): { + schemaVersion: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel type (from inside the model)' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library element UID' } }, + withUid(value): { + uid: value, + }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'panel version, incremented each time the dashboard is updated.' } }, + withVersion(value): { + version: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet new file mode 100644 index 0000000..f4688b2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet @@ -0,0 +1,26 @@ +// This file is generated, do not manually edit. +{ + '#': { + filename: 'main.libsonnet', + help: 'Jsonnet library for rendering Grafana resources\n## Install\n\n```\njb install github.com/grafana/grafonnet/gen/grafonnet-v11.0.0@main\n```\n\n## Usage\n\n```jsonnet\nlocal grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet"\n```\n', + 'import': 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet', + installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', + name: 'grafonnet', + url: 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0', + usageTemplate: '\n## Usage\n\n```jsonnet\nlocal %(name)s = import "%(import)s"\n```\n', + version: 'main', + }, + accesspolicy: import 'accesspolicy.libsonnet', + dashboard: import 'dashboard.libsonnet', + librarypanel: import 'librarypanel.libsonnet', + preferences: import 'preferences.libsonnet', + publicdashboard: import 'publicdashboard.libsonnet', + role: import 'role.libsonnet', + rolebinding: import 'rolebinding.libsonnet', + team: import 'team.libsonnet', + folder: import 'folder.libsonnet', + panel: import 'panelindex.libsonnet', + query: import 'query.libsonnet', + util: import 'custom/util/main.libsonnet', + alerting: import 'alerting.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel.libsonnet new file mode 100644 index 0000000..fb6d68a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel.libsonnet @@ -0,0 +1,803 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + panelOptions+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + title: value, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + description: value, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + transparent: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { + maxPerRow: value, + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + repeatDirection: value, + }, + '#withPluginVersion': { 'function': { args: [], help: '' } }, + withPluginVersion(): { + pluginVersion: 'v11.0.0', + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + type: value, + }, + link+: + { + '#': { help: '', name: 'link' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + }, + queryOptions+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + interval: value, + }, + '#withQueryCachingTTL': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Overrides the data source configured time-to-live for a query cache item in milliseconds' } }, + withQueryCachingTTL(value): { + queryCachingTTL: value, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + timeFrom: value, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + timeShift: value, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { + hideTimeOverride: value, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + targets: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + transformation+: + { + '#': { help: '', name: 'transformation' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + }, + standardOptions+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + mapping+: + { + '#': { help: '', name: 'mapping' }, + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + threshold+: { + step+: + { + '#': { help: '', name: 'step' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + override+: + { + '#': { help: '', name: 'override' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + libraryPanel+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel name' } }, + withName(value): { + libraryPanel+: { + name: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel uid' } }, + withUid(value): { + libraryPanel+: { + uid: value, + }, + }, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, +} ++ (import 'custom/panel.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/alertList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/alertList.libsonnet new file mode 100644 index 0000000..0865829 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/alertList.libsonnet @@ -0,0 +1,341 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.alertList', name: 'alertList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'alertlist', + }, + }, + options+: + { + '#withAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptions(value): { + options+: { + AlertListOptions: value, + }, + }, + '#withAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptionsMixin(value): { + options+: { + AlertListOptions+: value, + }, + }, + AlertListOptions+: + { + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDashboardTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDashboardTitle(value): { + options+: { + dashboardTitle: value, + }, + }, + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowOptions': { 'function': { args: [{ default: null, enums: ['current', 'changes'], name: 'value', type: ['string'] }], help: '' } }, + withShowOptions(value): { + options+: { + showOptions: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withAlerting': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAlerting(value=true): { + options+: { + stateFilter+: { + alerting: value, + }, + }, + }, + '#withExecutionError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExecutionError(value=true): { + options+: { + stateFilter+: { + execution_error: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + no_data: value, + }, + }, + }, + '#withOk': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOk(value=true): { + options+: { + stateFilter+: { + ok: value, + }, + }, + }, + '#withPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPaused(value=true): { + options+: { + stateFilter+: { + paused: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withUnifiedAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptions(value): { + options+: { + UnifiedAlertListOptions: value, + }, + }, + '#withUnifiedAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptionsMixin(value): { + options+: { + UnifiedAlertListOptions+: value, + }, + }, + UnifiedAlertListOptions+: + { + '#withAlertInstanceLabelFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertInstanceLabelFilter(value): { + options+: { + alertInstanceLabelFilter: value, + }, + }, + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasource(value): { + options+: { + datasource: value, + }, + }, + '#withFolder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolder(value): { + options+: { + folder: value, + }, + }, + '#withFolderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolderMixin(value): { + options+: { + folder+: value, + }, + }, + folder+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withId(value): { + options+: { + folder+: { + id: value, + }, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + options+: { + folder+: { + title: value, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + options+: { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + options+: { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupMode': { 'function': { args: [{ default: null, enums: ['default', 'custom'], name: 'value', type: ['string'] }], help: '' } }, + withGroupMode(value): { + options+: { + groupMode: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowInstances': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowInstances(value=true): { + options+: { + showInstances: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withError(value=true): { + options+: { + stateFilter+: { + 'error': value, + }, + }, + }, + '#withFiring': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFiring(value=true): { + options+: { + stateFilter+: { + firing: value, + }, + }, + }, + '#withInactive': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInactive(value=true): { + options+: { + stateFilter+: { + inactive: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + noData: value, + }, + }, + }, + '#withNormal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNormal(value=true): { + options+: { + stateFilter+: { + normal: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withViewMode': { 'function': { args: [{ default: null, enums: ['list', 'stat'], name: 'value', type: ['string'] }], help: '' } }, + withViewMode(value): { + options+: { + viewMode: value, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet new file mode 100644 index 0000000..ccf1c12 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/annotationsList.libsonnet @@ -0,0 +1,94 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.annotationsList', name: 'annotationsList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'annolist', + }, + }, + options+: + { + '#withLimit': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value=10): { + options+: { + limit: value, + }, + }, + '#withNavigateAfter': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateAfter(value='10m'): { + options+: { + navigateAfter: value, + }, + }, + '#withNavigateBefore': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateBefore(value='10m'): { + options+: { + navigateBefore: value, + }, + }, + '#withNavigateToPanel': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNavigateToPanel(value=true): { + options+: { + navigateToPanel: value, + }, + }, + '#withOnlyFromThisDashboard': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyFromThisDashboard(value=true): { + options+: { + onlyFromThisDashboard: value, + }, + }, + '#withOnlyInTimeRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyInTimeRange(value=true): { + options+: { + onlyInTimeRange: value, + }, + }, + '#withShowTags': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTags(value=true): { + options+: { + showTags: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withShowUser': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUser(value=true): { + options+: { + showUser: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barChart.libsonnet new file mode 100644 index 0000000..f86fafd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barChart.libsonnet @@ -0,0 +1,553 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barChart', name: 'barChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'barchart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBarRadius': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Controls the radius of each bar.' } }, + withBarRadius(value=0): { + options+: { + barRadius: value, + }, + }, + '#withBarWidth': { 'function': { args: [{ default: 0.97, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of bars. 1 = Max width, 0 = Min width.' } }, + withBarWidth(value=0.97): { + options+: { + barWidth: value, + }, + }, + '#withColorByField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use the color value for a sibling field to color each bar value.' } }, + withColorByField(value): { + options+: { + colorByField: value, + }, + }, + '#withFullHighlight': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area' } }, + withFullHighlight(value=true): { + options+: { + fullHighlight: value, + }, + }, + '#withGroupWidth': { 'function': { args: [{ default: 0.7, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of groups. 1 = max with, 0 = min width.' } }, + withGroupWidth(value=0.7): { + options+: { + groupWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withStacking(value): { + options+: { + stacking: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Manually select which field from the dataset to represent the x field.' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + '#withXTickLabelMaxLength': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the max length that a label can have before it is truncated.' } }, + withXTickLabelMaxLength(value): { + options+: { + xTickLabelMaxLength: value, + }, + }, + '#withXTickLabelRotation': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the rotation of the x axis labels.' } }, + withXTickLabelRotation(value=0): { + options+: { + xTickLabelRotation: value, + }, + }, + '#withXTickLabelSpacing': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior' } }, + withXTickLabelSpacing(value=0): { + options+: { + xTickLabelSpacing: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet new file mode 100644 index 0000000..5e20a61 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/barGauge.libsonnet @@ -0,0 +1,168 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barGauge', name: 'barGauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bargauge', + }, + }, + options+: + { + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withDisplayMode(value): { + options+: { + displayMode: value, + }, + }, + '#withMaxVizHeight': { 'function': { args: [{ default: 300, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxVizHeight(value=300): { + options+: { + maxVizHeight: value, + }, + }, + '#withMinVizHeight': { 'function': { args: [{ default: 16, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=16): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 8, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=8): { + options+: { + minVizWidth: value, + }, + }, + '#withNamePlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'left'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge name to be placed explicitly' } }, + withNamePlacement(value): { + options+: { + namePlacement: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowUnfilled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUnfilled(value=true): { + options+: { + showUnfilled: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withValueMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueMode(value): { + options+: { + valueMode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet new file mode 100644 index 0000000..feb03c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/candlestick.libsonnet @@ -0,0 +1,850 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.candlestick', name: 'candlestick' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'candlestick', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCandleStyle': { 'function': { args: [{ default: null, enums: ['candles', 'ohlcbars'], name: 'value', type: ['string'] }], help: '' } }, + withCandleStyle(value): { + options+: { + candleStyle: value, + }, + }, + '#withColorStrategy': { 'function': { args: [{ default: null, enums: ['open-close', 'close-close'], name: 'value', type: ['string'] }], help: '' } }, + withColorStrategy(value): { + options+: { + colorStrategy: value, + }, + }, + '#withColors': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColors(value): { + options+: { + colors: value, + }, + }, + '#withColorsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorsMixin(value): { + options+: { + colors+: value, + }, + }, + colors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { + options+: { + colors+: { + down: value, + }, + }, + }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { + options+: { + colors+: { + flat: value, + }, + }, + }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { + options+: { + colors+: { + up: value, + }, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFields(value): { + options+: { + fields: value, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFieldsMixin(value): { + options+: { + fields+: value, + }, + }, + fields+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { + options+: { + fields+: { + close: value, + }, + }, + }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { + options+: { + fields+: { + high: value, + }, + }, + }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { + options+: { + fields+: { + low: value, + }, + }, + }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { + options+: { + fields+: { + open: value, + }, + }, + }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { + options+: { + fields+: { + volume: value, + }, + }, + }, + }, + '#withIncludeAllFields': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled, all fields will be sent to the graph' } }, + withIncludeAllFields(value=true): { + options+: { + includeAllFields: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['candles+volume', 'candles', 'volume'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/canvas.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/canvas.libsonnet new file mode 100644 index 0000000..79af6fd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/canvas.libsonnet @@ -0,0 +1,544 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.canvas', name: 'canvas' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'canvas', + }, + }, + options+: + { + '#withInfinitePan': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable infinite pan' } }, + withInfinitePan(value=true): { + options+: { + infinitePan: value, + }, + }, + '#withInlineEditing': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable inline editing' } }, + withInlineEditing(value=true): { + options+: { + inlineEditing: value, + }, + }, + '#withPanZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable pan and zoom' } }, + withPanZoom(value=true): { + options+: { + panZoom: value, + }, + }, + '#withRoot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRoot(value): { + options+: { + root: value, + }, + }, + '#withRootMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRootMixin(value): { + options+: { + root+: value, + }, + }, + root+: + { + '#withElements': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElements(value): { + options+: { + root+: { + elements: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withElementsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElementsMixin(value): { + options+: { + root+: { + elements+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + elements+: + { + '#': { help: '', name: 'elements' }, + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { + background: value, + }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { + background+: value, + }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + background+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + background+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + background+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { + background+: { + image: value, + }, + }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { + background+: { + image+: value, + }, + }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + image+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + background+: { + image+: { + fixed: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + background+: { + image+: { + mode: value, + }, + }, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + background+: { + size: value, + }, + }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { + border: value, + }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { + border+: value, + }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + border+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + border+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + border+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + border+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRadius(value): { + border+: { + radius: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + border+: { + width: value, + }, + }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfigMixin(value): { + config+: value, + }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { + connections: + (if std.isArray(value) + then value + else [value]), + }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { + connections+: + (if std.isArray(value) + then value + else [value]), + }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + color: value, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + color+: value, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + color+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + color+: { + fixed: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { + path: value, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { + size: value, + }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { + size+: value, + }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + size+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + size+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + size+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + size+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + size+: { + mode: value, + }, + }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { + source: value, + }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { + source+: value, + }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + source+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + source+: { + y: value, + }, + }, + }, + '#withSourceOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginal(value): { + sourceOriginal: value, + }, + '#withSourceOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginalMixin(value): { + sourceOriginal+: value, + }, + sourceOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + sourceOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + sourceOriginal+: { + y: value, + }, + }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + target+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + target+: { + y: value, + }, + }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { + targetName: value, + }, + '#withTargetOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginal(value): { + targetOriginal: value, + }, + '#withTargetOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginalMixin(value): { + targetOriginal+: value, + }, + targetOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + targetOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + targetOriginal+: { + y: value, + }, + }, + }, + '#withVertices': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVertices(value): { + vertices: + (if std.isArray(value) + then value + else [value]), + }, + '#withVerticesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVerticesMixin(value): { + vertices+: + (if std.isArray(value) + then value + else [value]), + }, + vertices+: + { + '#': { help: '', name: 'vertices' }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { + constraint: value, + }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { + constraint+: value, + }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { + constraint+: { + horizontal: value, + }, + }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { + constraint+: { + vertical: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { + placement: value, + }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { + placement+: value, + }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { + placement+: { + bottom: value, + }, + }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { + placement+: { + height: value, + }, + }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { + placement+: { + left: value, + }, + }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { + placement+: { + right: value, + }, + }, + '#withRotation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRotation(value): { + placement+: { + rotation: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { + placement+: { + top: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + placement+: { + width: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the root element' } }, + withName(value): { + options+: { + root+: { + name: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: 'Type of root element (frame)' } }, + withType(): { + options+: { + root+: { + type: 'frame', + }, + }, + }, + }, + '#withShowAdvancedTypes': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show all available element types' } }, + withShowAdvancedTypes(value=true): { + options+: { + showAdvancedTypes: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet new file mode 100644 index 0000000..94a0e47 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/dashboardList.libsonnet @@ -0,0 +1,100 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.dashboardList', name: 'dashboardList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'dashlist', + }, + }, + options+: + { + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'folderId is deprecated, and migrated to folderUid on panel init' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + options+: { + folderUID: value, + }, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIncludeVars(value=true): { + options+: { + includeVars: value, + }, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withKeepTime(value=true): { + options+: { + keepTime: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxItems(value=10): { + options+: { + maxItems: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value=''): { + options+: { + query: value, + }, + }, + '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowHeadings(value=true): { + options+: { + showHeadings: value, + }, + }, + '#withShowRecentlyViewed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowRecentlyViewed(value=true): { + options+: { + showRecentlyViewed: value, + }, + }, + '#withShowSearch': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowSearch(value=true): { + options+: { + showSearch: value, + }, + }, + '#withShowStarred': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowStarred(value=true): { + options+: { + showStarred: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet new file mode 100644 index 0000000..c93f787 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/datagrid.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'datagrid', + }, + }, + options+: + { + '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSelectedSeries(value=0): { + options+: { + selectedSeries: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/debug.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/debug.libsonnet new file mode 100644 index 0000000..3cc3f99 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/debug.libsonnet @@ -0,0 +1,67 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.debug', name: 'debug' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'debug', + }, + }, + options+: + { + '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCounters(value): { + options+: { + counters: value, + }, + }, + '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCountersMixin(value): { + options+: { + counters+: value, + }, + }, + counters+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { + options+: { + counters+: { + dataChanged: value, + }, + }, + }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { + options+: { + counters+: { + render: value, + }, + }, + }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { + options+: { + counters+: { + schemaChanged: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/gauge.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/gauge.libsonnet new file mode 100644 index 0000000..02ebaff --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/gauge.libsonnet @@ -0,0 +1,150 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.gauge', name: 'gauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'gauge', + }, + }, + options+: + { + '#withMinVizHeight': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=75): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=75): { + options+: { + minVizWidth: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowThresholdLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdLabels(value=true): { + options+: { + showThresholdLabels: value, + }, + }, + '#withShowThresholdMarkers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdMarkers(value=true): { + options+: { + showThresholdMarkers: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/geomap.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/geomap.libsonnet new file mode 100644 index 0000000..b8e9cc6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/geomap.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.geomap', name: 'geomap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geomap', + }, + }, + options+: + { + '#withBasemap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemap(value): { + options+: { + basemap: value, + }, + }, + '#withBasemapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemapMixin(value): { + options+: { + basemap+: value, + }, + }, + basemap+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + options+: { + basemap+: { + config: value, + }, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + options+: { + basemap+: { + config+: value, + }, + }, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + options+: { + basemap+: { + filterData: value, + }, + }, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + options+: { + basemap+: { + filterData+: value, + }, + }, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { + options+: { + basemap+: { + location: value, + }, + }, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { + options+: { + basemap+: { + location+: value, + }, + }, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + options+: { + basemap+: { + location+: { + gazetteer: value, + }, + }, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + options+: { + basemap+: { + location+: { + geohash: value, + }, + }, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + options+: { + basemap+: { + location+: { + latitude: value, + }, + }, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + options+: { + basemap+: { + location+: { + longitude: value, + }, + }, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + options+: { + basemap+: { + location+: { + lookup: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + basemap+: { + location+: { + mode: value, + }, + }, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + options+: { + basemap+: { + location+: { + wkt: value, + }, + }, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + options+: { + basemap+: { + name: value, + }, + }, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + options+: { + basemap+: { + opacity: value, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + options+: { + basemap+: { + tooltip: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + options+: { + basemap+: { + type: value, + }, + }, + }, + }, + '#withControls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControls(value): { + options+: { + controls: value, + }, + }, + '#withControlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsMixin(value): { + options+: { + controls+: value, + }, + }, + controls+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { + options+: { + controls+: { + mouseWheelZoom: value, + }, + }, + }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { + options+: { + controls+: { + showAttribution: value, + }, + }, + }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { + options+: { + controls+: { + showDebug: value, + }, + }, + }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { + options+: { + controls+: { + showMeasure: value, + }, + }, + }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { + options+: { + controls+: { + showScale: value, + }, + }, + }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { + options+: { + controls+: { + showZoom: value, + }, + }, + }, + }, + '#withLayers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayers(value): { + options+: { + layers: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLayersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayersMixin(value): { + options+: { + layers+: + (if std.isArray(value) + then value + else [value]), + }, + }, + layers+: + { + '#': { help: '', name: 'layers' }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + config+: value, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + filterData: value, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + filterData+: value, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLocationMixin(value): { + location+: value, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + location+: { + gazetteer: value, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + location+: { + geohash: value, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + location+: { + latitude: value, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + location+: { + longitude: value, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + location+: { + lookup: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + location+: { + mode: value, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + location+: { + wkt: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + name: value, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + opacity: value, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withView(value): { + options+: { + view: value, + }, + }, + '#withViewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withViewMixin(value): { + options+: { + view+: value, + }, + }, + view+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { + options+: { + view+: { + allLayers: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { + options+: { + view+: { + id: value, + }, + }, + }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { + options+: { + view+: { + lastOnly: value, + }, + }, + }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { + options+: { + view+: { + lat: value, + }, + }, + }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { + options+: { + view+: { + layer: value, + }, + }, + }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { + options+: { + view+: { + lon: value, + }, + }, + }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { + options+: { + view+: { + maxZoom: value, + }, + }, + }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { + options+: { + view+: { + minZoom: value, + }, + }, + }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { + options+: { + view+: { + padding: value, + }, + }, + }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { + options+: { + view+: { + shared: value, + }, + }, + }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { + options+: { + view+: { + zoom: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet new file mode 100644 index 0000000..2c974fc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/heatmap.libsonnet @@ -0,0 +1,839 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.heatmap', name: 'heatmap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'heatmap', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCalculate': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the heatmap should be calculated from data' } }, + withCalculate(value=true): { + options+: { + calculate: value, + }, + }, + '#withCalculation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculation(value): { + options+: { + calculation: value, + }, + }, + '#withCalculationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCalculationMixin(value): { + options+: { + calculation+: value, + }, + }, + calculation+: + { + '#withXBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBuckets(value): { + options+: { + calculation+: { + xBuckets: value, + }, + }, + }, + '#withXBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withXBucketsMixin(value): { + options+: { + calculation+: { + xBuckets+: value, + }, + }, + }, + xBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + calculation+: { + xBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + xBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + xBuckets+: { + value: value, + }, + }, + }, + }, + }, + '#withYBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBuckets(value): { + options+: { + calculation+: { + yBuckets: value, + }, + }, + }, + '#withYBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withYBucketsMixin(value): { + options+: { + calculation+: { + yBuckets+: value, + }, + }, + }, + yBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + calculation+: { + yBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + yBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + yBuckets+: { + value: value, + }, + }, + }, + }, + }, + }, + '#withCellGap': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls gap between cells' } }, + withCellGap(value=1): { + options+: { + cellGap: value, + }, + }, + '#withCellRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls cell radius' } }, + withCellRadius(value): { + options+: { + cellRadius: value, + }, + }, + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { + options+: { + cellValues: value, + }, + }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { + options+: { + cellValues+: value, + }, + }, + cellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { + options+: { + cellValues+: { + decimals: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { + options+: { + cellValues+: { + unit: value, + }, + }, + }, + }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColor(value): { + options+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColorMixin(value): { + options+: { + color+: value, + }, + }, + color+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { + options+: { + color+: { + exponent: value, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { + options+: { + color+: { + fill: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { + options+: { + color+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { + options+: { + color+: { + min: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { + options+: { + color+: { + mode: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { + options+: { + color+: { + reverse: value, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { + options+: { + color+: { + scale: value, + }, + }, + }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { + options+: { + color+: { + scheme: value, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { + options+: { + color+: { + steps: value, + }, + }, + }, + }, + '#withExemplars': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplars(value): { + options+: { + exemplars: value, + }, + }, + '#withExemplarsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarsMixin(value): { + options+: { + exemplars+: value, + }, + }, + exemplars+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { + options+: { + exemplars+: { + color: value, + }, + }, + }, + }, + '#withFilterValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValues(value): { + options+: { + filterValues: value, + }, + }, + '#withFilterValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValuesMixin(value): { + options+: { + filterValues+: value, + }, + }, + filterValues+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { + options+: { + filterValues+: { + ge: value, + }, + }, + }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { + options+: { + filterValues+: { + le: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { + options+: { + legend+: { + show: value, + }, + }, + }, + }, + '#withRowsFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrame(value): { + options+: { + rowsFrame: value, + }, + }, + '#withRowsFrameMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrameMixin(value): { + options+: { + rowsFrame+: value, + }, + }, + rowsFrame+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: '' } }, + withLayout(value): { + options+: { + rowsFrame+: { + layout: value, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { + options+: { + rowsFrame+: { + value: value, + }, + }, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withShowColorScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a color scale in header' } }, + withShowColorScale(value=true): { + options+: { + tooltip+: { + showColorScale: value, + }, + }, + }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { + options+: { + tooltip+: { + yHistogram: value, + }, + }, + }, + }, + '#withYAxis': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxis(value): { + options+: { + yAxis: value, + }, + }, + '#withYAxisMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisMixin(value): { + options+: { + yAxis+: value, + }, + }, + yAxis+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + options+: { + yAxis+: { + axisBorderShow: value, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + options+: { + yAxis+: { + axisCenteredZero: value, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + options+: { + yAxis+: { + axisColorMode: value, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + options+: { + yAxis+: { + axisGridShow: value, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + options+: { + yAxis+: { + axisLabel: value, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + options+: { + yAxis+: { + axisPlacement: value, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + options+: { + yAxis+: { + axisSoftMax: value, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + options+: { + yAxis+: { + axisSoftMin: value, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + options+: { + yAxis+: { + axisWidth: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { + options+: { + yAxis+: { + decimals: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { + options+: { + yAxis+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { + options+: { + yAxis+: { + min: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { + options+: { + yAxis+: { + reverse: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + options+: { + yAxis+: { + scaleDistribution: value, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + options+: { + yAxis+: { + scaleDistribution+: value, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + yAxis+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + yAxis+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + yAxis+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { + options+: { + yAxis+: { + unit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/histogram.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/histogram.libsonnet new file mode 100644 index 0000000..cb8ce7a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/histogram.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.histogram', name: 'histogram' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBucketCount': { 'function': { args: [{ default: 30, enums: null, name: 'value', type: ['integer'] }], help: 'Bucket count (approx)' } }, + withBucketCount(value=30): { + options+: { + bucketCount: value, + }, + }, + '#withBucketOffset': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Offset buckets by this amount' } }, + withBucketOffset(value=0): { + options+: { + bucketOffset: value, + }, + }, + '#withBucketSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Size of each bucket' } }, + withBucketSize(value): { + options+: { + bucketSize: value, + }, + }, + '#withCombine': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Combines multiple series into a single histogram' } }, + withCombine(value=true): { + options+: { + combine: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/logs.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/logs.libsonnet new file mode 100644 index 0000000..a21ed84 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/logs.libsonnet @@ -0,0 +1,76 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.logs', name: 'logs' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + options+: + { + '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, + withDedupStrategy(value): { + options+: { + dedupStrategy: value, + }, + }, + '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnableLogDetails(value=true): { + options+: { + enableLogDetails: value, + }, + }, + '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPrettifyLogMessage(value=true): { + options+: { + prettifyLogMessage: value, + }, + }, + '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowCommonLabels(value=true): { + options+: { + showCommonLabels: value, + }, + }, + '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLabels(value=true): { + options+: { + showLabels: value, + }, + }, + '#withShowLogContextToggle': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLogContextToggle(value=true): { + options+: { + showLogContextToggle: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapLogMessage(value=true): { + options+: { + wrapLogMessage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/news.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/news.libsonnet new file mode 100644 index 0000000..eede487 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/news.libsonnet @@ -0,0 +1,34 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.news', name: 'news' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'news', + }, + }, + options+: + { + '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, + withFeedUrl(value): { + options+: { + feedUrl: value, + }, + }, + '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowImage(value=true): { + options+: { + showImage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet new file mode 100644 index 0000000..75e183a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/nodeGraph.libsonnet @@ -0,0 +1,118 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.nodeGraph', name: 'nodeGraph' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nodeGraph', + }, + }, + options+: + { + '#withEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdges(value): { + options+: { + edges: value, + }, + }, + '#withEdgesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgesMixin(value): { + options+: { + edges+: value, + }, + }, + edges+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + edges+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + edges+: { + secondaryStatUnit: value, + }, + }, + }, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + options+: { + nodes: value, + }, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + options+: { + nodes+: value, + }, + }, + nodes+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { + options+: { + nodes+: { + arcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { + options+: { + nodes+: { + arcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { + color: value, + }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { + field: value, + }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + nodes+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + nodes+: { + secondaryStatUnit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet new file mode 100644 index 0000000..9ec5edc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/pieChart.libsonnet @@ -0,0 +1,380 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.pieChart', name: 'pieChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'piechart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDisplayLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabels(value): { + options+: { + displayLabels: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDisplayLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabelsMixin(value): { + options+: { + displayLabels+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { + options+: { + legend+: { + values: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { + options+: { + legend+: { + values+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withPieType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieType(value): { + options+: { + pieType: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/row.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/row.libsonnet new file mode 100644 index 0000000..1548d38 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/row.libsonnet @@ -0,0 +1,103 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.row', name: 'row' }, + '#withCollapsed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether this row should be collapsed or not.' } }, + withCollapsed(value=true): { + collapsed: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withGridPos': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPos(value): { + gridPos: value, + }, + '#withGridPosMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPosMixin(value): { + gridPos+: value, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.' } }, + withId(value): { + id: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Row title' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'row', + }, +} ++ (import '../custom/row.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stat.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stat.libsonnet new file mode 100644 index 0000000..7b6b25b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stat.libsonnet @@ -0,0 +1,156 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stat', name: 'stat' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'stat', + }, + }, + options+: + { + '#withColorMode': { 'function': { args: [{ default: null, enums: ['value', 'background', 'background_solid', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withColorMode(value): { + options+: { + colorMode: value, + }, + }, + '#withGraphMode': { 'function': { args: [{ default: null, enums: ['none', 'line', 'area'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGraphMode(value): { + options+: { + graphMode: value, + }, + }, + '#withJustifyMode': { 'function': { args: [{ default: null, enums: ['auto', 'center'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withJustifyMode(value): { + options+: { + justifyMode: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowPercentChange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowPercentChange(value=true): { + options+: { + showPercentChange: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTextMode': { 'function': { args: [{ default: null, enums: ['auto', 'value', 'value_and_name', 'name', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTextMode(value): { + options+: { + textMode: value, + }, + }, + '#withWideLayout': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWideLayout(value=true): { + options+: { + wideLayout: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet new file mode 100644 index 0000000..a18899d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/stateTimeline.libsonnet @@ -0,0 +1,309 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stateTimeline', name: 'stateTimeline' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'state-timeline', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=0): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withAlignValue': { 'function': { args: [{ default: null, enums: ['center', 'left', 'right'], name: 'value', type: ['string'] }], help: 'Controls the value alignment in the TimelineChart component' } }, + withAlignValue(value): { + options+: { + alignValue: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMergeValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Merge equal consecutive values' } }, + withMergeValues(value=true): { + options+: { + mergeValues: value, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Controls the row height' } }, + withRowHeight(value=0.9): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet new file mode 100644 index 0000000..676b5f7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/statusHistory.libsonnet @@ -0,0 +1,303 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.statusHistory', name: 'statusHistory' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'status-history', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withColWidth': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Controls the column width' } }, + withColWidth(value=0.9): { + options+: { + colWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Set the height of the rows' } }, + withRowHeight(value=0.9): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/table.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/table.libsonnet new file mode 100644 index 0000000..2e08163 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/table.libsonnet @@ -0,0 +1,1274 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.table', name: 'table' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'table', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAlign': { 'function': { args: [{ default: null, enums: ['auto', 'left', 'right', 'center'], name: 'value', type: ['string'] }], help: 'TODO -- should not be table specific!\nTODO docs' } }, + withAlign(value): { + fieldConfig+: { + defaults+: { + custom+: { + align: value, + }, + }, + }, + }, + '#withCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions: value, + }, + }, + }, + }, + '#withCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: value, + }, + }, + }, + }, + cellOptions+: + { + '#withTableAutoCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions: value, + }, + }, + }, + }, + }, + '#withTableAutoCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions+: value, + }, + }, + }, + }, + }, + TableAutoCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'auto', + }, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions: value, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions+: value, + }, + }, + }, + }, + }, + TableSparklineCellOptions+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisBorderShow: value, + }, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisCenteredZero: value, + }, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisColorMode: value, + }, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisGridShow: value, + }, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisLabel: value, + }, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisPlacement: value, + }, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMax: value, + }, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMin: value, + }, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisWidth: value, + }, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barAlignment: value, + }, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barMaxWidth: value, + }, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barWidthFactor: value, + }, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + drawStyle: value, + }, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillBelowTo: value, + }, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillColor: value, + }, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillOpacity: value, + }, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + gradientMode: value, + }, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom: value, + }, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: value, + }, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + '#withHideValue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHideValue(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideValue: value, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineColor: value, + }, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineInterpolation: value, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle: value, + }, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: value, + }, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineWidth: value, + }, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointColor: value, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSize: value, + }, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSymbol: value, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution: value, + }, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: value, + }, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + showPoints: value, + }, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls: value, + }, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls+: value, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking: value, + }, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: value, + }, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle: value, + }, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: value, + }, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + transform: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'sparkline', + }, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions: value, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions+: value, + }, + }, + }, + }, + }, + TableBarGaugeCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'gauge', + }, + }, + }, + }, + }, + '#withValueDisplayMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + valueDisplayMode: value, + }, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions+: value, + }, + }, + }, + }, + }, + TableColoredBackgroundCellOptions+: + { + '#withApplyToRow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withApplyToRow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + applyToRow: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'gradient'], name: 'value', type: ['string'] }], help: 'Display mode to the "Colored Background" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-background', + }, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions+: value, + }, + }, + }, + }, + }, + TableColorTextCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-text', + }, + }, + }, + }, + }, + }, + '#withTableImageCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions: value, + }, + }, + }, + }, + }, + '#withTableImageCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions+: value, + }, + }, + }, + }, + }, + TableImageCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'image', + }, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions: value, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions+: value, + }, + }, + }, + }, + }, + TableDataLinksCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'data-links', + }, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions: value, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions+: value, + }, + }, + }, + }, + }, + TableJsonViewCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'json-view', + }, + }, + }, + }, + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['auto', 'color-text', 'color-background', 'color-background-solid', 'gradient-gauge', 'lcd-gauge', 'json-view', 'basic', 'image', 'gauge', 'sparkline', 'data-links', 'custom'], name: 'value', type: ['string'] }], help: "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions" } }, + withDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + displayMode: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + filterable: value, + }, + }, + }, + }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '?? default is missing or false ??' } }, + withHidden(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hidden: value, + }, + }, + }, + }, + '#withHideHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Hides any header for a column, useful for columns that show some static content or buttons.' } }, + withHideHeader(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideHeader: value, + }, + }, + }, + }, + '#withInspect': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInspect(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + inspect: value, + }, + }, + }, + }, + '#withMinWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMinWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + minWidth: value, + }, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + width: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCellHeight': { 'function': { args: [{ default: null, enums: ['sm', 'md', 'lg'], name: 'value', type: ['string'] }], help: 'Height of a table cell' } }, + withCellHeight(value): { + options+: { + cellHeight: value, + }, + }, + '#withFooter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooter(value): { + options+: { + footer: value, + }, + }, + '#withFooterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooterMixin(value): { + options+: { + footer+: value, + }, + }, + footer+: + { + '#withCountRows': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withCountRows(value=true): { + options+: { + footer+: { + countRows: value, + }, + }, + }, + '#withEnablePagination': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnablePagination(value=true): { + options+: { + footer+: { + enablePagination: value, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + options+: { + footer+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + options+: { + footer+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducer(value): { + options+: { + footer+: { + reducer: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducerMixin(value): { + options+: { + footer+: { + reducer+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShow(value=true): { + options+: { + footer+: { + show: value, + }, + }, + }, + }, + '#withFrameIndex': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Represents the index of the selected frame' } }, + withFrameIndex(value=0): { + options+: { + frameIndex: value, + }, + }, + '#withShowHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the panel should show the header' } }, + withShowHeader(value=true): { + options+: { + showHeader: value, + }, + }, + '#withShowTypeIcons': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the header should show icons for the column types' } }, + withShowTypeIcons(value=true): { + options+: { + showTypeIcons: value, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortBy(value): { + options+: { + sortBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSortByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortByMixin(value): { + options+: { + sortBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + sortBy+: + { + '#': { help: '', name: 'sortBy' }, + '#withDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag used to indicate descending sort order' } }, + withDesc(value=true): { + desc: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the display name of the field to sort by' } }, + withDisplayName(value): { + displayName: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/text.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/text.libsonnet new file mode 100644 index 0000000..2fd04fd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/text.libsonnet @@ -0,0 +1,73 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.text', name: 'text' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'text', + }, + }, + options+: + { + '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCode(value): { + options+: { + code: value, + }, + }, + '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeMixin(value): { + options+: { + code+: value, + }, + }, + code+: + { + '#withLanguage': { 'function': { args: [{ default: null, enums: ['json', 'yaml', 'xml', 'typescript', 'sql', 'go', 'markdown', 'html', 'plaintext'], name: 'value', type: ['string'] }], help: '' } }, + withLanguage(value): { + options+: { + code+: { + language: value, + }, + }, + }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { + options+: { + code+: { + showLineNumbers: value, + }, + }, + }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { + options+: { + code+: { + showMiniMap: value, + }, + }, + }, + }, + '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { + options+: { + content: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet new file mode 100644 index 0000000..f9bf740 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/timeSeries.libsonnet @@ -0,0 +1,767 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.timeSeries', name: 'timeSeries' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'timeseries', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + timezone+: + { + '#withTimeZoneUtc': { 'function': { args: [], help: 'Use UTC/GMT timezone' } }, + withTimeZoneUtc(): { + TimeZoneUtc: 'utc', + }, + '#withTimeZoneBrowser': { 'function': { args: [], help: 'Use the timezone defined by end user web browser' } }, + withTimeZoneBrowser(): { + TimeZoneBrowser: 'browser', + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/trend.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/trend.libsonnet new file mode 100644 index 0000000..929422f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/trend.libsonnet @@ -0,0 +1,738 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.trend', name: 'trend' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'trend', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'integer'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the x field to use (defaults to first number)' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet new file mode 100644 index 0000000..f8f3a2a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panel/xyChart.libsonnet @@ -0,0 +1,1070 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.xyChart', name: 'xyChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'xychart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + label: value, + }, + }, + }, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue: value, + }, + }, + }, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: value, + }, + }, + }, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: value, + }, + }, + }, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: value, + }, + }, + }, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: value, + }, + }, + }, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + max: value, + }, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + min: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { + fieldConfig+: { + defaults+: { + custom+: { + show: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDims': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDims(value): { + options+: { + dims: value, + }, + }, + '#withDimsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDimsMixin(value): { + options+: { + dims+: value, + }, + }, + dims+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { + options+: { + dims+: { + exclude: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { + options+: { + dims+: { + exclude+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { + options+: { + dims+: { + frame: value, + }, + }, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + options+: { + dims+: { + x: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withSeries': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeries(value): { + options+: { + series: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSeriesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeriesMixin(value): { + options+: { + series+: + (if std.isArray(value) + then value + else [value]), + }, + }, + series+: + { + '#': { help: '', name: 'series' }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + axisBorderShow: value, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + axisCenteredZero: value, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + axisColorMode: value, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + axisGridShow: value, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + axisLabel: value, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + axisPlacement: value, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + axisSoftMax: value, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + axisSoftMin: value, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + axisWidth: value, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFrame(value): { + frame: value, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + hideFrom: value, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + hideFrom+: value, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + hideFrom+: { + legend: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + hideFrom+: { + tooltip: value, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + hideFrom+: { + viz: value, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value): { + label: value, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + labelValue: value, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + labelValue+: value, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + labelValue+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + labelValue+: { + fixed: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + labelValue+: { + mode: value, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + lineColor: value, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + lineColor+: value, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + lineColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + lineColor+: { + fixed: value, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + lineStyle: value, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + lineStyle+: value, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + lineStyle+: { + fill: value, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + lineWidth: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + pointColor: value, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + pointColor+: value, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + pointColor+: { + fixed: value, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + pointSize: value, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + pointSize+: value, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointSize+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + pointSize+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + pointSize+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + pointSize+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + pointSize+: { + mode: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + scaleDistribution: value, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + scaleDistribution+: value, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + scaleDistribution+: { + linearThreshold: value, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + scaleDistribution+: { + log: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + scaleDistribution+: { + type: value, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: null, enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value): { + show: value, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Auto is "table" in the UI' } }, + withSeriesMapping(value): { + options+: { + seriesMapping: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panelindex.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panelindex.libsonnet new file mode 100644 index 0000000..cffcdad --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/panelindex.libsonnet @@ -0,0 +1,30 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + alertList: import 'panel/alertList.libsonnet', + annotationsList: import 'panel/annotationsList.libsonnet', + barChart: import 'panel/barChart.libsonnet', + barGauge: import 'panel/barGauge.libsonnet', + candlestick: import 'panel/candlestick.libsonnet', + canvas: import 'panel/canvas.libsonnet', + dashboardList: import 'panel/dashboardList.libsonnet', + datagrid: import 'panel/datagrid.libsonnet', + debug: import 'panel/debug.libsonnet', + gauge: import 'panel/gauge.libsonnet', + geomap: import 'panel/geomap.libsonnet', + heatmap: import 'panel/heatmap.libsonnet', + histogram: import 'panel/histogram.libsonnet', + logs: import 'panel/logs.libsonnet', + news: import 'panel/news.libsonnet', + nodeGraph: import 'panel/nodeGraph.libsonnet', + pieChart: import 'panel/pieChart.libsonnet', + stat: import 'panel/stat.libsonnet', + stateTimeline: import 'panel/stateTimeline.libsonnet', + statusHistory: import 'panel/statusHistory.libsonnet', + table: import 'panel/table.libsonnet', + text: import 'panel/text.libsonnet', + timeSeries: import 'panel/timeSeries.libsonnet', + trend: import 'panel/trend.libsonnet', + xyChart: import 'panel/xyChart.libsonnet', + row: import 'panel/row.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/preferences.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/preferences.libsonnet new file mode 100644 index 0000000..e91b037 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/preferences.libsonnet @@ -0,0 +1,88 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.preferences', name: 'preferences' }, + '#withCookiePreferences': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferences(value): { + cookiePreferences: value, + }, + '#withCookiePreferencesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCookiePreferencesMixin(value): { + cookiePreferences+: value, + }, + cookiePreferences+: + { + '#withAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalytics(value): { + cookiePreferences+: { + analytics: value, + }, + }, + '#withAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalyticsMixin(value): { + cookiePreferences+: { + analytics+: value, + }, + }, + '#withFunctional': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctional(value): { + cookiePreferences+: { + functional: value, + }, + }, + '#withFunctionalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctionalMixin(value): { + cookiePreferences+: { + functional+: value, + }, + }, + '#withPerformance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformance(value): { + cookiePreferences+: { + performance: value, + }, + }, + '#withPerformanceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformanceMixin(value): { + cookiePreferences+: { + performance+: value, + }, + }, + }, + '#withHomeDashboardUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID for the home dashboard' } }, + withHomeDashboardUID(value): { + homeDashboardUID: value, + }, + '#withLanguage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Selected language (beta)' } }, + withLanguage(value): { + language: value, + }, + '#withQueryHistory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistory(value): { + queryHistory: value, + }, + '#withQueryHistoryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryHistoryMixin(value): { + queryHistory+: value, + }, + queryHistory+: + { + '#withHomeTab': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "one of: '' | 'query' | 'starred';" } }, + withHomeTab(value): { + queryHistory+: { + homeTab: value, + }, + }, + }, + '#withTheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'light, dark, empty is default' } }, + withTheme(value): { + theme: value, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The timezone selection\nTODO: this should use the timezone defined in common' } }, + withTimezone(value): { + timezone: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'day of the week (sunday, monday, etc)' } }, + withWeekStart(value): { + weekStart: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/publicdashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/publicdashboard.libsonnet new file mode 100644 index 0000000..200e638 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/publicdashboard.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.publicdashboard', name: 'publicdashboard' }, + '#withAccessToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public access token' } }, + withAccessToken(value): { + accessToken: value, + }, + '#withAnnotationsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if annotations are enabled' } }, + withAnnotationsEnabled(value=true): { + annotationsEnabled: value, + }, + '#withDashboardUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Dashboard unique identifier referenced by this public dashboard' } }, + withDashboardUid(value): { + dashboardUid: value, + }, + '#withIsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the public dashboard is enabled' } }, + withIsEnabled(value=true): { + isEnabled: value, + }, + '#withTimeSelectionEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the time range picker is enabled' } }, + withTimeSelectionEnabled(value=true): { + timeSelectionEnabled: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public dashboard identifier' } }, + withUid(value): { + uid: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query.libsonnet new file mode 100644 index 0000000..129a0ea --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query.libsonnet @@ -0,0 +1,15 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query', name: 'query' }, + azureMonitor: import 'query/azureMonitor.libsonnet', + cloudWatch: import 'query/cloudWatch.libsonnet', + elasticsearch: import 'query/elasticsearch.libsonnet', + expr: import 'query/expr.libsonnet', + googleCloudMonitoring: import 'query/googleCloudMonitoring.libsonnet', + grafanaPyroscope: import 'query/grafanaPyroscope.libsonnet', + loki: import 'query/loki.libsonnet', + parca: import 'query/parca.libsonnet', + prometheus: import 'query/prometheus.libsonnet', + tempo: import 'query/tempo.libsonnet', + testData: import 'query/testData.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet new file mode 100644 index 0000000..0188b39 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/azureMonitor.libsonnet @@ -0,0 +1,860 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.azureMonitor', name: 'azureMonitor' }, + '#withAzureLogAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalytics(value): { + azureLogAnalytics: value, + }, + '#withAzureLogAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalyticsMixin(value): { + azureLogAnalytics+: value, + }, + azureLogAnalytics+: + { + '#withDashboardTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false.' } }, + withDashboardTime(value=true): { + azureLogAnalytics+: { + dashboardTime: value, + }, + }, + '#withIntersectTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated Use dashboardTime instead' } }, + withIntersectTime(value=true): { + azureLogAnalytics+: { + intersectTime: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureLogAnalytics+: { + query: value, + }, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResource(value): { + azureLogAnalytics+: { + resource: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureLogAnalytics+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureLogAnalytics+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { + azureLogAnalytics+: { + resultFormat: value, + }, + }, + '#withTimeColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated' } }, + withTimeColumn(value): { + azureLogAnalytics+: { + timeColumn: value, + }, + }, + '#withWorkspace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Workspace ID. This was removed in Grafana 8, but remains for backwards compat.' } }, + withWorkspace(value): { + azureLogAnalytics+: { + workspace: value, + }, + }, + }, + '#withAzureMonitor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitor(value): { + azureMonitor: value, + }, + '#withAzureMonitorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureMonitorMixin(value): { + azureMonitor+: value, + }, + azureMonitor+: + { + '#withAggregation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.' } }, + withAggregation(value): { + azureMonitor+: { + aggregation: value, + }, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.' } }, + withAlias(value): { + azureMonitor+: { + alias: value, + }, + }, + '#withAllowedTimeGrainsMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMs(value): { + azureMonitor+: { + allowedTimeGrainsMs: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withAllowedTimeGrainsMsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMsMixin(value): { + azureMonitor+: { + allowedTimeGrainsMs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withCustomNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Used as the value for the metricNamespace property when it's different from the resource namespace." } }, + withCustomNamespace(value): { + azureMonitor+: { + customNamespace: value, + }, + }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimension(value): { + azureMonitor+: { + dimension: value, + }, + }, + '#withDimensionFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimensionFilter(value): { + azureMonitor+: { + dimensionFilter: value, + }, + }, + '#withDimensionFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFilters(value): { + azureMonitor+: { + dimensionFilters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDimensionFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFiltersMixin(value): { + azureMonitor+: { + dimensionFilters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + dimensionFilters+: + { + '#': { help: '', name: 'dimensionFilters' }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of Dimension to be filtered on.' } }, + withDimension(value): { + dimension: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated filter is deprecated in favour of filters to support multiselect.' } }, + withFilter(value): { + filter: value, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators." } }, + withOperator(value): { + operator: value, + }, + }, + '#withMetricDefinition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use metricNamespace instead' } }, + withMetricDefinition(value): { + azureMonitor+: { + metricDefinition: value, + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The metric to query data for within the specified metricNamespace. e.g. UsedCapacity' } }, + withMetricName(value): { + azureMonitor+: { + metricName: value, + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues." } }, + withMetricNamespace(value): { + azureMonitor+: { + metricNamespace: value, + }, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The Azure region containing the resource(s).' } }, + withRegion(value): { + azureMonitor+: { + region: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceGroup(value): { + azureMonitor+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceName(value): { + azureMonitor+: { + resourceName: value, + }, + }, + '#withResourceUri': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resourceGroup, resourceName and metricNamespace instead' } }, + withResourceUri(value): { + azureMonitor+: { + resourceUri: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureMonitor+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureMonitor+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + resources+: + { + '#': { help: '', name: 'resources' }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + metricNamespace: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value): { + region: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + resourceName: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + subscription: value, + }, + }, + '#withTimeGrain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The granularity of data points to be queried. Defaults to auto.' } }, + withTimeGrain(value): { + azureMonitor+: { + timeGrain: value, + }, + }, + '#withTimeGrainUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated' } }, + withTimeGrainUnit(value): { + azureMonitor+: { + timeGrainUnit: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Maximum number of records to return. Defaults to 10.' } }, + withTop(value): { + azureMonitor+: { + top: value, + }, + }, + }, + '#withAzureResourceGraph': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraph(value): { + azureResourceGraph: value, + }, + '#withAzureResourceGraphMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAzureResourceGraphMixin(value): { + azureResourceGraph+: value, + }, + azureResourceGraph+: + { + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Resource Graph KQL query to be executed.' } }, + withQuery(value): { + azureResourceGraph+: { + query: value, + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as. Defaults to table.' } }, + withResultFormat(value): { + azureResourceGraph+: { + resultFormat: value, + }, + }, + }, + '#withAzureTraces': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTraces(value): { + azureTraces: value, + }, + '#withAzureTracesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTracesMixin(value): { + azureTraces+: value, + }, + azureTraces+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFilters(value): { + azureTraces+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFiltersMixin(value): { + azureTraces+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comparison operator to use. Either equals or not equals.' } }, + withOperation(value): { + operation: value, + }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Property name, auto-populated based on available traces.' } }, + withProperty(value): { + property: value, + }, + }, + '#withOperationId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Operation ID. Used only for Traces queries.' } }, + withOperationId(value): { + azureTraces+: { + operationId: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureTraces+: { + query: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureTraces+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureTraces+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: '' } }, + withResultFormat(value): { + azureTraces+: { + resultFormat: value, + }, + }, + '#withTraceTypes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypes(value): { + azureTraces+: { + traceTypes: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTraceTypesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypesMixin(value): { + azureTraces+: { + traceTypes+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withGrafanaTemplateVariableFn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '' } }, + withGrafanaTemplateVariableFn(value): { + grafanaTemplateVariableFn: value, + }, + '#withGrafanaTemplateVariableFnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '' } }, + withGrafanaTemplateVariableFnMixin(value): { + grafanaTemplateVariableFn+: value, + }, + grafanaTemplateVariableFn+: + { + '#withAppInsightsMetricNameQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery: value, + }, + }, + '#withAppInsightsMetricNameQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery+: value, + }, + }, + AppInsightsMetricNameQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsMetricNameQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withAppInsightsGroupByQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery: value, + }, + }, + '#withAppInsightsGroupByQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery+: value, + }, + }, + AppInsightsGroupByQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsGroupByQuery', + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricName(value): { + grafanaTemplateVariableFn+: { + metricName: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withSubscriptionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQuery(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery: value, + }, + }, + '#withSubscriptionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery+: value, + }, + }, + SubscriptionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'SubscriptionsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withResourceGroupsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQuery(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery: value, + }, + }, + '#withResourceGroupsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery+: value, + }, + }, + ResourceGroupsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceGroupsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withResourceNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQuery(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery: value, + }, + }, + '#withResourceNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery+: value, + }, + }, + ResourceNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamespaceQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery: value, + }, + }, + '#withMetricNamespaceQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery+: value, + }, + }, + MetricNamespaceQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamespaceQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricDefinitionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQuery(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery: value, + }, + }, + '#withMetricDefinitionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery+: value, + }, + }, + MetricDefinitionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricDefinitionsQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery: value, + }, + }, + '#withMetricNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery+: value, + }, + }, + MetricNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withWorkspacesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQuery(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery: value, + }, + }, + '#withWorkspacesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQueryMixin(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery+: value, + }, + }, + WorkspacesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'WorkspacesQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withUnknownQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQuery(value): { + grafanaTemplateVariableFn+: { + UnknownQuery: value, + }, + }, + '#withUnknownQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQueryMixin(value): { + grafanaTemplateVariableFn+: { + UnknownQuery+: value, + }, + }, + UnknownQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'UnknownQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNamespace(value): { + namespace: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Monitor query type.\nqueryType: #AzureQueryType' } }, + withRegion(value): { + region: value, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResource(value): { + resource: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Template variables params. These exist for backwards compatiblity with legacy template variables.' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure subscription containing the resource(s) to be queried.' } }, + withSubscription(value): { + subscription: value, + }, + '#withSubscriptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptions(value): { + subscriptions: + (if std.isArray(value) + then value + else [value]), + }, + '#withSubscriptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptionsMixin(value): { + subscriptions+: + (if std.isArray(value) + then value + else [value]), + }, +} ++ (import '../custom/query/azureMonitor.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet new file mode 100644 index 0000000..fa54d6e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/cloudWatch.libsonnet @@ -0,0 +1,693 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.cloudWatch', name: 'cloudWatch' }, + CloudWatchAnnotationQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withActionPrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`' } }, + withActionPrefix(value): { + actionPrefix: value, + }, + '#withAlarmNamePrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`' } }, + withAlarmNamePrefix(value): { + alarmNamePrefix: value, + }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withPrefixMatching': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix' } }, + withPrefixMatching(value=true): { + prefixMatching: value, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchLogsQuery+: + { + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The CloudWatch Logs Insights query to execute' } }, + withExpression(value): { + expression: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withLogGroupNames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNames(value): { + logGroupNames: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupNamesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNamesMixin(value): { + logGroupNames+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroups(value): { + logGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroupsMixin(value): { + logGroups+: + (if std.isArray(value) + then value + else [value]), + }, + logGroups+: + { + '#': { help: '', name: 'logGroups' }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AccountId of the log group' } }, + withAccountId(value): { + accountId: value, + }, + '#withAccountLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Label of the log group' } }, + withAccountLabel(value): { + accountLabel: value, + }, + '#withArn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ARN of the log group' } }, + withArn(value): { + arn: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the log group' } }, + withName(value): { + name: value, + }, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the logs' } }, + withRegion(value): { + region: value, + }, + '#withStatsGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroups(value): { + statsGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatsGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroupsMixin(value): { + statsGroups+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchMetricsQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Deprecated: use label\n@deprecated use label' } }, + withAlias(value): { + alias: value, + }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Math expression query' } }, + withExpression(value): { + expression: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.' } }, + withId(value): { + id: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.' } }, + withLabel(value): { + label: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricEditorMode': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withMetricEditorMode(value): { + metricEditorMode: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withMetricQueryType': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withMetricQueryType(value): { + metricQueryType: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withQueryMode': { 'function': { args: [{ default: null, enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: '' } }, + withQueryMode(value): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSql(value): { + sql: value, + }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSqlMixin(value): { + sql+: value, + }, + sql+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFrom(value): { + sql+: { + from: value, + }, + }, + '#withFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFromMixin(value): { + sql+: { + from+: value, + }, + }, + from+: + { + '#withQueryEditorPropertyExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpression(value): { + sql+: { + from+: { + QueryEditorPropertyExpression: value, + }, + }, + }, + '#withQueryEditorPropertyExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpressionMixin(value): { + sql+: { + from+: { + QueryEditorPropertyExpression+: value, + }, + }, + }, + QueryEditorPropertyExpression+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + sql+: { + from+: { + property: value, + }, + }, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + sql+: { + from+: { + property+: value, + }, + }, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + property+: { + name: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + from+: { + property+: { + type: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'property', + }, + }, + }, + }, + '#withQueryEditorFunctionExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpression(value): { + sql+: { + from+: { + QueryEditorFunctionExpression: value, + }, + }, + }, + '#withQueryEditorFunctionExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpressionMixin(value): { + sql+: { + from+: { + QueryEditorFunctionExpression+: value, + }, + }, + }, + QueryEditorFunctionExpression+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + from+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + from+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'function', + }, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupBy(value): { + sql+: { + groupBy: value, + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withGroupByMixin(value): { + sql+: { + groupBy+: value, + }, + }, + groupBy+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + groupBy+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + groupBy+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + groupBy+: { + type: value, + }, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'LIMIT part of the SQL expression' } }, + withLimit(value): { + sql+: { + limit: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderBy(value): { + sql+: { + orderBy: value, + }, + }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderByMixin(value): { + sql+: { + orderBy+: value, + }, + }, + orderBy+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + orderBy+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + orderBy+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + orderBy+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + orderBy+: { + type: 'function', + }, + }, + }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The sort order of the SQL expression, `ASC` or `DESC`' } }, + withOrderByDirection(value): { + sql+: { + orderByDirection: value, + }, + }, + '#withSelect': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelect(value): { + sql+: { + select: value, + }, + }, + '#withSelectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSelectMixin(value): { + sql+: { + select+: value, + }, + }, + select+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + select+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + select+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + select+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + select+: { + type: 'function', + }, + }, + }, + }, + '#withWhere': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhere(value): { + sql+: { + where: value, + }, + }, + '#withWhereMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWhereMixin(value): { + sql+: { + where+: value, + }, + }, + where+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + where+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + where+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + where+: { + type: value, + }, + }, + }, + }, + }, + '#withSqlExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.' } }, + withSqlExpression(value): { + sqlExpression: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, +} ++ (import '../custom/query/cloudWatch.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet new file mode 100644 index 0000000..99171aa --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/elasticsearch.libsonnet @@ -0,0 +1,1452 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.elasticsearch', name: 'elasticsearch' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alias pattern' } }, + withAlias(value): { + alias: value, + }, + '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggs(value): { + bucketAggs: + (if std.isArray(value) + then value + else [value]), + }, + '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggsMixin(value): { + bucketAggs+: + (if std.isArray(value) + then value + else [value]), + }, + bucketAggs+: + { + DateHistogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOffset(value): { + settings+: { + offset: value, + }, + }, + '#withTimeZone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeZone(value): { + settings+: { + timeZone: value, + }, + }, + '#withTrimEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTrimEdges(value): { + settings+: { + trimEdges: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'date_histogram', + }, + }, + Histogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + Terms+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: ['desc', 'asc'], name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'terms', + }, + }, + Filters+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + settings+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + settings+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabel(value): { + label: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value): { + query: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'filters', + }, + }, + GeoHashGrid+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withPrecision': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecision(value): { + settings+: { + precision: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geohash_grid', + }, + }, + Nested+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nested', + }, + }, + }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetrics(value): { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetricsMixin(value): { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + metrics+: + { + Count+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'count', + }, + }, + PipelineMetricAggregation+: + { + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + }, + MetricAggregationWithSettings+: + { + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + SerialDiff+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLag(value): { + settings+: { + lag: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'serial_diff', + }, + }, + RawData+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_data', + }, + }, + RawDocument+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_document', + }, + }, + UniqueCount+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPrecisionThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecisionThreshold(value): { + settings+: { + precision_threshold: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cardinality', + }, + }, + Percentiles+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPercents': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercents(value): { + settings+: { + percents: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPercentsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercentsMixin(value): { + settings+: { + percents+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'percentiles', + }, + }, + ExtendedStats+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { + meta+: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withSigma': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSigma(value): { + settings+: { + sigma: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'extended_stats', + }, + }, + Min+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'min', + }, + }, + Max+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'max', + }, + }, + Sum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sum', + }, + }, + Average+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'avg', + }, + }, + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + MovingFunction+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withShift(value): { + settings+: { + shift: value, + }, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWindow(value): { + settings+: { + window: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_fn', + }, + }, + Logs+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLimit(value): { + settings+: { + limit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + Rate+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'rate', + }, + }, + TopMetrics+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetrics(value): { + settings+: { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetricsMixin(value): { + settings+: { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'top_metrics', + }, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Lucene query' } }, + withQuery(value): { + query: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of time field' } }, + withTimeField(value): { + timeField: value, + }, +} ++ (import '../custom/query/elasticsearch.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/expr.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/expr.libsonnet new file mode 100644 index 0000000..fa34bc8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/expr.libsonnet @@ -0,0 +1,996 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.expr', name: 'expr' }, + TypeMath+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'General math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'math', + }, + }, + TypeReduce+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last'], name: 'value', type: ['string'] }], help: 'The reducer\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` ' } }, + withReducer(value): { + reducer: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['dropNN', 'replaceNN'], name: 'value', type: ['string'] }], help: 'Non-number reduce behavior\nPossible enum values:\n - `"dropNN"` Drop non-numbers\n - `"replaceNN"` Replace non-numbers' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withReplaceWithValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Only valid when mode is replace' } }, + withReplaceWithValue(value): { + settings+: { + replaceWithValue: value, + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'reduce', + }, + }, + TypeResample+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDownsampler': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last'], name: 'value', type: ['string'] }], help: 'The downsample function\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` ' } }, + withDownsampler(value): { + downsampler: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'resample', + }, + '#withUpsampler': { 'function': { args: [{ default: null, enums: ['pad', 'backfilling', 'fillna'], name: 'value', type: ['string'] }], help: 'The upsample function\nPossible enum values:\n - `"pad"` Use the last seen value\n - `"backfilling"` backfill\n - `"fillna"` Do not fill values (nill)' } }, + withUpsampler(value): { + upsampler: value, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The time duration' } }, + withWindow(value): { + window: value, + }, + }, + TypeClassicConditions+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperator(value): { + operator: value, + }, + '#withOperatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperatorMixin(value): { + operator+: value, + }, + operator+: + { + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + operator+: { + type: value, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryMixin(value): { + query+: value, + }, + query+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + query+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + query+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducer(value): { + reducer: value, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducerMixin(value): { + reducer+: value, + }, + reducer+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + reducer+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'classic_conditions', + }, + }, + TypeThreshold+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withLoadedDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensions(value): { + loadedDimensions: value, + }, + '#withLoadedDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensionsMixin(value): { + loadedDimensions+: value, + }, + '#withUnloadEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluator(value): { + unloadEvaluator: value, + }, + '#withUnloadEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluatorMixin(value): { + unloadEvaluator+: value, + }, + unloadEvaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + unloadEvaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + unloadEvaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + unloadEvaluator+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'threshold', + }, + }, + TypeSql+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The datasource' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withApiVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The apiserver version' } }, + withApiVersion(value): { + datasource+: { + apiVersion: value, + }, + }, + '#withType': { 'function': { args: [], help: 'The datasource plugin type' } }, + withType(): { + datasource+: { + type: '__expr__', + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID (NOTE: name in k8s)' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sql', + }, + }, +} ++ (import '../custom/query/expr.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet new file mode 100644 index 0000000..478a49c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,293 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.googleCloudMonitoring', name: 'googleCloudMonitoring' }, + '#withAliasBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.' } }, + withAliasBy(value): { + aliasBy: value, + }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Time interval in milliseconds.' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withPromQLQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQuery(value): { + promQLQuery: value, + }, + '#withPromQLQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQueryMixin(value): { + promQLQuery+: value, + }, + promQLQuery+: + { + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL expression/query to be executed.' } }, + withExpr(value): { + promQLQuery+: { + expr: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + promQLQuery+: { + projectName: value, + }, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL min step' } }, + withStep(value): { + promQLQuery+: { + step: value, + }, + }, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSloQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQuery(value): { + sloQuery: value, + }, + '#withSloQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQueryMixin(value): { + sloQuery+: value, + }, + sloQuery+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + sloQuery+: { + alignmentPeriod: value, + }, + }, + '#withGoal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'SLO goal value.' } }, + withGoal(value): { + sloQuery+: { + goal: value, + }, + }, + '#withLookbackPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific lookback period for the SLO.' } }, + withLookbackPeriod(value): { + sloQuery+: { + lookbackPeriod: value, + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + sloQuery+: { + perSeriesAligner: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + sloQuery+: { + projectName: value, + }, + }, + '#withSelectorName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'SLO selector.' } }, + withSelectorName(value): { + sloQuery+: { + selectorName: value, + }, + }, + '#withServiceId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the service the SLO is in.' } }, + withServiceId(value): { + sloQuery+: { + serviceId: value, + }, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name for the service the SLO is in.' } }, + withServiceName(value): { + sloQuery+: { + serviceName: value, + }, + }, + '#withSloId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the SLO.' } }, + withSloId(value): { + sloQuery+: { + sloId: value, + }, + }, + '#withSloName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the SLO.' } }, + withSloName(value): { + sloQuery+: { + sloName: value, + }, + }, + }, + '#withTimeSeriesList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesList(value): { + timeSeriesList: value, + }, + '#withTimeSeriesListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesListMixin(value): { + timeSeriesList+: value, + }, + timeSeriesList+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + timeSeriesList+: { + alignmentPeriod: value, + }, + }, + '#withCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withCrossSeriesReducer(value): { + timeSeriesList+: { + crossSeriesReducer: value, + }, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFilters(value): { + timeSeriesList+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFiltersMixin(value): { + timeSeriesList+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBys(value): { + timeSeriesList+: { + groupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBysMixin(value): { + timeSeriesList+: { + groupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + timeSeriesList+: { + perSeriesAligner: value, + }, + }, + '#withPreprocessor': { 'function': { args: [{ default: null, enums: ['none', 'rate', 'delta'], name: 'value', type: ['string'] }], help: 'Types of pre-processor available. Defined by the metric.' } }, + withPreprocessor(value): { + timeSeriesList+: { + preprocessor: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesList+: { + projectName: value, + }, + }, + '#withSecondaryAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withSecondaryAlignmentPeriod(value): { + timeSeriesList+: { + secondaryAlignmentPeriod: value, + }, + }, + '#withSecondaryCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withSecondaryCrossSeriesReducer(value): { + timeSeriesList+: { + secondaryCrossSeriesReducer: value, + }, + }, + '#withSecondaryGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBys(value): { + timeSeriesList+: { + secondaryGroupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBysMixin(value): { + timeSeriesList+: { + secondaryGroupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withSecondaryPerSeriesAligner(value): { + timeSeriesList+: { + secondaryPerSeriesAligner: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation text.' } }, + withText(value): { + timeSeriesList+: { + text: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation title.' } }, + withTitle(value): { + timeSeriesList+: { + title: value, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Data view, defaults to FULL.' } }, + withView(value): { + timeSeriesList+: { + view: value, + }, + }, + }, + '#withTimeSeriesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQuery(value): { + timeSeriesQuery: value, + }, + '#withTimeSeriesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQueryMixin(value): { + timeSeriesQuery+: value, + }, + timeSeriesQuery+: + { + '#withGraphPeriod': { 'function': { args: [{ default: 'disabled', enums: null, name: 'value', type: ['string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriod(value='disabled'): { + timeSeriesQuery+: { + graphPeriod: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesQuery+: { + projectName: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'MQL query to be executed.' } }, + withQuery(value): { + timeSeriesQuery+: { + query: value, + }, + }, + }, +} ++ (import '../custom/query/googleCloudMonitoring.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet new file mode 100644 index 0000000..67a7566 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/grafanaPyroscope.libsonnet @@ -0,0 +1,65 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.grafanaPyroscope', name: 'grafanaPyroscope' }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the maximum number of nodes in the flamegraph.' } }, + withMaxNodes(value): { + maxNodes: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSpanSelector': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, + withSpanSelector(value): { + spanSelector: + (if std.isArray(value) + then value + else [value]), + }, + '#withSpanSelectorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, + withSpanSelectorMixin(value): { + spanSelector+: + (if std.isArray(value) + then value + else [value]), + }, +} ++ (import '../custom/query/grafanaPyroscope.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/loki.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/loki.libsonnet new file mode 100644 index 0000000..2d77f4b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/loki.libsonnet @@ -0,0 +1,57 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.loki', name: 'loki' }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The LogQL query.' } }, + withExpr(value): { + expr: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withInstant(value=true): { + instant: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to override the name of the series.' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Used to limit the number of log rows returned.' } }, + withMaxLines(value): { + maxLines: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withRange(value=true): { + range: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '@deprecated, now use step.' } }, + withResolution(value): { + resolution: value, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to set step value for range queries.' } }, + withStep(value): { + step: value, + }, +} ++ (import '../custom/query/loki.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/parca.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/parca.libsonnet new file mode 100644 index 0000000..94f6f23 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/parca.libsonnet @@ -0,0 +1,33 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.parca', name: 'parca' }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, +} ++ (import '../custom/query/parca.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/prometheus.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/prometheus.libsonnet new file mode 100644 index 0000000..1d42ef3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/prometheus.libsonnet @@ -0,0 +1,61 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Execute an additional query to identify interesting raw samples relevant for the given expr' } }, + withExemplar(value=true): { + exemplar: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The actual expression/query that will be evaluated by Prometheus' } }, + withExpr(value): { + expr: value, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: ['time_series', 'table', 'heatmap'], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns only the latest value that Prometheus has scraped for the requested time series' } }, + withInstant(value=true): { + instant: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An additional lower limit for the step parameter of the Prometheus query and for the\n`$__interval` and `$__rate_interval` variables.' } }, + withInterval(value): { + interval: value, + }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081' } }, + withIntervalFactor(value): { + intervalFactor: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series' } }, + withRange(value=true): { + range: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, +} ++ (import '../custom/query/prometheus.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/tempo.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/tempo.libsonnet new file mode 100644 index 0000000..61ed290 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/tempo.libsonnet @@ -0,0 +1,165 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, + '#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" } }, + withDatasource(value): { + datasource: value, + }, + '#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" } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of traces that are returned from Tempo' } }, + withLimit(value): { + limit: value, + }, + '#withMaxDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMaxDuration(value): { + maxDuration: value, + }, + '#withMinDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMinDuration(value): { + minDuration: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TraceQL query or trace ID' } }, + withQuery(value): { + query: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSearch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true' } }, + withSearch(value): { + search: value, + }, + '#withServiceMapIncludeNamespace': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Use service.namespace in addition to service.name to uniquely identify a service.' } }, + withServiceMapIncludeNamespace(value=true): { + serviceMapIncludeNamespace: value, + }, + '#withServiceMapQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQuery(value): { + serviceMapQuery: value, + }, + '#withServiceMapQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQueryMixin(value): { + serviceMapQuery+: value, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by service name' } }, + withServiceName(value): { + serviceName: value, + }, + '#withSpanName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by span name' } }, + withSpanName(value): { + spanName: value, + }, + '#withSpss': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of spans per spanset that are returned from Tempo' } }, + withSpss(value): { + spss: value, + }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + withTableType(value): { + tableType: value, + }, +} ++ (import '../custom/query/tempo.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/testData.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/testData.libsonnet new file mode 100644 index 0000000..a0bdee5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/query/testData.libsonnet @@ -0,0 +1,494 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.testData', name: 'testData' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlias(value): { + alias: value, + }, + '#withChannel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used for live query' } }, + withChannel(value): { + channel: value, + }, + '#withCsvContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvContent(value): { + csvContent: value, + }, + '#withCsvFileName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvFileName(value): { + csvFileName: value, + }, + '#withCsvWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWave(value): { + csvWave: + (if std.isArray(value) + then value + else [value]), + }, + '#withCsvWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWaveMixin(value): { + csvWave+: + (if std.isArray(value) + then value + else [value]), + }, + csvWave+: + { + '#': { help: '', name: 'csvWave' }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + timeStep: value, + }, + '#withValuesCSV': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValuesCSV(value): { + valuesCSV: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The datasource plugin type' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Datasource UID' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDropPercent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Drop percentage (the chance we will lose a point 0-100)' } }, + withDropPercent(value): { + dropPercent: value, + }, + '#withErrorType': { 'function': { args: [{ default: null, enums: ['frontend_exception', 'frontend_observable', 'server_panic'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"frontend_exception"` \n - `"frontend_observable"` \n - `"server_panic"` ' } }, + withErrorType(value): { + errorType: value, + }, + '#withFlamegraphDiff': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFlamegraphDiff(value=true): { + flamegraphDiff: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLevelColumn': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLevelColumn(value=true): { + levelColumn: value, + }, + '#withLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLines(value): { + lines: value, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + max: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + min: value, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + nodes: value, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + nodes+: value, + }, + nodes+: + { + '#withCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withCount(value): { + nodes+: { + count: value, + }, + }, + '#withSeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeed(value): { + nodes+: { + seed: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['random', 'random edges', 'response_medium', 'response_small', 'feature_showcase'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"random"` \n - `"random edges"` \n - `"response_medium"` \n - `"response_small"` \n - `"feature_showcase"` ' } }, + withType(value): { + nodes+: { + type: value, + }, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + noise: value, + }, + '#withPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPoints(value): { + points: + (if std.isArray(value) + then value + else [value]), + }, + '#withPointsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPointsMixin(value): { + points+: + (if std.isArray(value) + then value + else [value]), + }, + '#withPulseWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWave(value): { + pulseWave: value, + }, + '#withPulseWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWaveMixin(value): { + pulseWave+: value, + }, + pulseWave+: + { + '#withOffCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffCount(value): { + pulseWave+: { + offCount: value, + }, + }, + '#withOffValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOffValue(value): { + pulseWave+: { + offValue: value, + }, + }, + '#withOnCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOnCount(value): { + pulseWave+: { + onCount: value, + }, + }, + '#withOnValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOnValue(value): { + pulseWave+: { + onValue: value, + }, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + pulseWave+: { + timeStep: value, + }, + }, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawFrameContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawFrameContent(value): { + rawFrameContent: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withScenarioId': { 'function': { args: [{ default: null, enums: ['annotations', 'arrow', 'csv_content', 'csv_file', 'csv_metric_values', 'datapoints_outside_range', 'exponential_heatmap_bucket_data', 'flame_graph', 'grafana_api', 'linear_heatmap_bucket_data', 'live', 'logs', 'manual_entry', 'no_data_points', 'node_graph', 'predictable_csv_wave', 'predictable_pulse', 'random_walk', 'random_walk_table', 'random_walk_with_error', 'raw_frame', 'server_error_500', 'simulation', 'slow_query', 'streaming_client', 'table_static', 'trace', 'usa', 'variables-query'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"annotations"` \n - `"arrow"` \n - `"csv_content"` \n - `"csv_file"` \n - `"csv_metric_values"` \n - `"datapoints_outside_range"` \n - `"exponential_heatmap_bucket_data"` \n - `"flame_graph"` \n - `"grafana_api"` \n - `"linear_heatmap_bucket_data"` \n - `"live"` \n - `"logs"` \n - `"manual_entry"` \n - `"no_data_points"` \n - `"node_graph"` \n - `"predictable_csv_wave"` \n - `"predictable_pulse"` \n - `"random_walk"` \n - `"random_walk_table"` \n - `"random_walk_with_error"` \n - `"raw_frame"` \n - `"server_error_500"` \n - `"simulation"` \n - `"slow_query"` \n - `"streaming_client"` \n - `"table_static"` \n - `"trace"` \n - `"usa"` \n - `"variables-query"` ' } }, + withScenarioId(value): { + scenarioId: value, + }, + '#withSeriesCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeriesCount(value): { + seriesCount: value, + }, + '#withSim': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSim(value): { + sim: value, + }, + '#withSimMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSimMixin(value): { + sim+: value, + }, + sim+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfig(value): { + sim+: { + config: value, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfigMixin(value): { + sim+: { + config+: value, + }, + }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKey(value): { + sim+: { + key: value, + }, + }, + '#withKeyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKeyMixin(value): { + sim+: { + key+: value, + }, + }, + key+: + { + '#withTick': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTick(value): { + sim+: { + key+: { + tick: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sim+: { + key+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { + sim+: { + key+: { + uid: value, + }, + }, + }, + }, + '#withLast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLast(value=true): { + sim+: { + last: value, + }, + }, + '#withStream': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withStream(value=true): { + sim+: { + stream: value, + }, + }, + }, + '#withSpanCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpanCount(value): { + spanCount: value, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + spread: value, + }, + '#withStartValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withStartValue(value): { + startValue: value, + }, + '#withStream': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStream(value): { + stream: value, + }, + '#withStreamMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStreamMixin(value): { + stream+: value, + }, + stream+: + { + '#withBands': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withBands(value): { + stream+: { + bands: value, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + stream+: { + noise: value, + }, + }, + '#withSpeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpeed(value): { + stream+: { + speed: value, + }, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + stream+: { + spread: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['fetch', 'logs', 'signal', 'traces'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"fetch"` \n - `"logs"` \n - `"signal"` \n - `"traces"` ' } }, + withType(value): { + stream+: { + type: value, + }, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUrl(value): { + stream+: { + url: value, + }, + }, + }, + '#withStringInput': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'common parameter used by many query types' } }, + withStringInput(value): { + stringInput: value, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withUsa': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsa(value): { + usa: value, + }, + '#withUsaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsaMixin(value): { + usa+: value, + }, + usa+: + { + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + usa+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + usa+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + usa+: { + mode: value, + }, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPeriod(value): { + usa+: { + period: value, + }, + }, + '#withStates': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStates(value): { + usa+: { + states: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withStatesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStatesMixin(value): { + usa+: { + states+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWithNil': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWithNil(value=true): { + withNil: value, + }, +} ++ (import '../custom/query/testData.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/role.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/role.libsonnet new file mode 100644 index 0000000..552f5a3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/role.libsonnet @@ -0,0 +1,24 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.role', name: 'role' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Role description' } }, + withDescription(value): { + description: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display' } }, + withDisplayName(value): { + displayName: value, + }, + '#withGroupName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withGroupName(value): { + groupName: value, + }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Do not show this role' } }, + withHidden(value=true): { + hidden: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, + withName(value): { + name: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/rolebinding.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/rolebinding.libsonnet new file mode 100644 index 0000000..acf521e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/rolebinding.libsonnet @@ -0,0 +1,92 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.rolebinding', name: 'rolebinding' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withBuiltinRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRef(value): { + role+: { + BuiltinRoleRef: value, + }, + }, + '#withBuiltinRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRefMixin(value): { + role+: { + BuiltinRoleRef+: value, + }, + }, + BuiltinRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'BuiltinRole', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: ['viewer', 'editor', 'admin'], name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + '#withCustomRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRef(value): { + role+: { + CustomRoleRef: value, + }, + }, + '#withCustomRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRefMixin(value): { + role+: { + CustomRoleRef+: value, + }, + }, + CustomRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'Role', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + }, + '#withSubject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubject(value): { + subject: value, + }, + '#withSubjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubjectMixin(value): { + subject+: value, + }, + subject+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Team', 'User'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + subject+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The team/user identifier name' } }, + withName(value): { + subject+: { + name: value, + }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/team.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/team.libsonnet new file mode 100644 index 0000000..429a64f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/team.libsonnet @@ -0,0 +1,12 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.team', name: 'team' }, + '#withEmail': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Email of the team.' } }, + withEmail(value): { + email: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withName(value): { + name: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/accesspolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/accesspolicy.libsonnet new file mode 100644 index 0000000..2f07e07 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/accesspolicy.libsonnet @@ -0,0 +1,90 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.accesspolicy', name: 'accesspolicy' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The role that must apply this policy' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The role that must apply this policy' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Role', 'BuiltinRole', 'Team', 'User'], name: 'value', type: ['string'] }], help: 'Policies can apply to roles, teams, or users\nApplying policies to individual users is supported, but discouraged' } }, + withKind(value): { + role+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + '#withXname': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withXname(value): { + role+: { + xname: value, + }, + }, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The set of rules to apply. Note that * is required to modify\naccess policy rules, and that "none" will reject all actions' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + rules+: + { + '#': { help: '', name: 'rules' }, + '#withKind': { 'function': { args: [{ default: '*', enums: null, name: 'value', type: ['string'] }], help: 'The kind this rule applies to (dashboards, alert, etc)' } }, + withKind(value='*'): { + kind: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific sub-elements like "alert.rules" or "dashboard.permissions"????' } }, + withTarget(value): { + target: value, + }, + '#withVerb': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerb(value): { + verb: value, + }, + '#withVerbMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'string', 'string'] }], help: 'READ, WRITE, CREATE, DELETE, ...\nshould move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete"' } }, + withVerbMixin(value): { + verb+: value, + }, + }, + '#withScope': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The scope where these policies should apply' } }, + withScope(value): { + scope: value, + }, + '#withScopeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The scope where these policies should apply' } }, + withScopeMixin(value): { + scope+: value, + }, + scope+: + { + '#withKind': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + scope+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + scope+: { + name: value, + }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/alerting.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/alerting.libsonnet new file mode 100644 index 0000000..c5e1415 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/alerting.libsonnet @@ -0,0 +1,9 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting', name: 'alerting' }, + contactPoint: import 'clean/alerting/contactPoint.libsonnet', + notificationPolicy: import 'clean/alerting/notificationPolicy.libsonnet', + muteTiming: import 'clean/alerting/muteTiming.libsonnet', + ruleGroup: import 'clean/alerting/ruleGroup.libsonnet', + notificationTemplate: import 'clean/alerting/notificationTemplate.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/contactPoint.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..13c81df --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/contactPoint.libsonnet @@ -0,0 +1,33 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.contactPoint', name: 'contactPoint' }, + '#withDisableResolveMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDisableResolveMessage(value=true): { + disableResolveMessage: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name is used as grouping key in the UI. Contact points with the\nsame name will be grouped in the UI.' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#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: '' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID is the unique identifier of the contact point. The UID can be\nset by the user.' } }, + withUid(value): { + uid: value, + }, +} ++ (import '../../custom/alerting/contactPoint.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/muteTiming.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..a36d339 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/muteTiming.libsonnet @@ -0,0 +1,135 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.muteTiming', name: 'muteTiming' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + interval+: + { + '#': { help: '', name: 'interval' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervals(value): { + time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimeIntervalsMixin(value): { + time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + time_intervals+: + { + '#': { help: '', name: 'time_intervals' }, + '#withDaysOfMonth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonth(value): { + days_of_month: + (if std.isArray(value) + then value + else [value]), + }, + '#withDaysOfMonthMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDaysOfMonthMixin(value): { + days_of_month+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withMonths': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonths(value): { + months: + (if std.isArray(value) + then value + else [value]), + }, + '#withMonthsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMonthsMixin(value): { + months+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimes(value): { + times: + (if std.isArray(value) + then value + else [value]), + }, + '#withTimesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimesMixin(value): { + times+: + (if std.isArray(value) + then value + else [value]), + }, + times+: + { + '#': { help: '', name: 'times' }, + '#withEndTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withEndTime(value): { + end_time: value, + }, + '#withStartTime': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withStartTime(value): { + start_time: value, + }, + }, + '#withWeekdays': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdays(value): { + weekdays: + (if std.isArray(value) + then value + else [value]), + }, + '#withWeekdaysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withWeekdaysMixin(value): { + weekdays+: + (if std.isArray(value) + then value + else [value]), + }, + '#withYears': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYears(value): { + years: + (if std.isArray(value) + then value + else [value]), + }, + '#withYearsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withYearsMixin(value): { + years+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ (import '../../custom/alerting/muteTiming.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationPolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..5de952e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationPolicy.libsonnet @@ -0,0 +1,97 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationPolicy', name: 'notificationPolicy' }, + '#withContinue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withContinue(value=true): { + continue: value, + }, + '#withGroupInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupInterval(value): { + group_interval: value, + }, + '#withGroupWait': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroupWait(value): { + group_wait: value, + }, + '#withRepeatInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRepeatInterval(value): { + repeat_interval: value, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + group_by: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + group_by+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchers(value): { + matchers: + (if std.isArray(value) + then value + else [value]), + }, + '#withMatchersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Matchers is a slice of Matchers that is sortable, implements Stringer, and\nprovides a Matches method to match a LabelSet against all Matchers in the\nslice. Note that some users of Matchers might require it to be sorted.' } }, + withMatchersMixin(value): { + matchers+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervals(value): { + mute_time_intervals: + (if std.isArray(value) + then value + else [value]), + }, + '#withMuteTimeIntervalsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMuteTimeIntervalsMixin(value): { + mute_time_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + '#withReceiver': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withReceiver(value): { + receiver: value, + }, + '#withRoutes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutes(value): { + routes: + (if std.isArray(value) + then value + else [value]), + }, + '#withRoutesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRoutesMixin(value): { + routes+: + (if std.isArray(value) + then value + else [value]), + }, + matcher+: + { + '#': { help: '', name: 'matcher' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + Name: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['=', '!=', '=~', '!~'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + Type: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValue(value): { + Value: value, + }, + }, +} ++ (import '../../custom/alerting/notificationPolicy.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationTemplate.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationTemplate.libsonnet new file mode 100644 index 0000000..b33d72c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/notificationTemplate.libsonnet @@ -0,0 +1,20 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.notificationTemplate', name: 'notificationTemplate' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withProvenance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProvenance(value): { + provenance: value, + }, + '#withTemplate': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTemplate(value): { + template: value, + }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withVersion(value): { + version: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/ruleGroup.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..92ddca4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/clean/alerting/ruleGroup.libsonnet @@ -0,0 +1,147 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.alerting.ruleGroup', name: 'ruleGroup' }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withInterval(value): { + interval: value, + }, + '#withRules': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRules(value): { + rules: + (if std.isArray(value) + then value + else [value]), + }, + '#withRulesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withRulesMixin(value): { + rules+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + rule+: + { + '#withAnnotations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotations(value): { + annotations: value, + }, + '#withAnnotationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnnotationsMixin(value): { + annotations+: value, + }, + '#withCondition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCondition(value): { + condition: value, + }, + '#withData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withData(value): { + data: + (if std.isArray(value) + then value + else [value]), + }, + '#withDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDataMixin(value): { + data+: + (if std.isArray(value) + then value + else [value]), + }, + '#withExecErrState': { 'function': { args: [{ default: null, enums: ['OK', 'Alerting', 'Error'], name: 'value', type: ['string'] }], help: '' } }, + withExecErrState(value): { + execErrState: value, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + folderUID: value, + }, + '#withFor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing.\nBefore this time has elapsed, the rule is only considered to be Pending.' } }, + withFor(value): { + 'for': value, + }, + '#withIsPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsPaused(value=true): { + isPaused: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelsMixin(value): { + labels+: value, + }, + '#withNoDataState': { 'function': { args: [{ default: null, enums: ['Alerting', 'NoData', 'OK'], name: 'value', type: ['string'] }], help: '' } }, + withNoDataState(value): { + noDataState: value, + }, + '#withOrgID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOrgID(value): { + orgID: value, + }, + '#withRuleGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRuleGroup(value): { + ruleGroup: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + title: value, + }, + data+: + { + '#': { help: '', name: 'data' }, + '#withDatasourceUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation." } }, + withDatasourceUid(value): { + datasourceUid: value, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'JSON is the raw JSON query and includes the above properties as well as custom properties.' } }, + withModelMixin(value): { + model+: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withRelativeTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRange(value): { + relativeTimeRange: value, + }, + '#withRelativeTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'RelativeTimeRange is the per query start and end time\nfor requests.' } }, + withRelativeTimeRangeMixin(value): { + relativeTimeRange+: value, + }, + relativeTimeRange+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withFrom(value): { + relativeTimeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Duration in seconds.' } }, + withTo(value): { + relativeTimeRange+: { + to: value, + }, + }, + }, + }, + }, +} ++ (import '../../custom/alerting/ruleGroup.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/contactPoint.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/contactPoint.libsonnet new file mode 100644 index 0000000..4b8bbf0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/contactPoint.libsonnet @@ -0,0 +1,12 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#'+:: { + help+: + ||| + + + **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. + |||, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/muteTiming.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/muteTiming.libsonnet new file mode 100644 index 0000000..4a2efb3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/muteTiming.libsonnet @@ -0,0 +1,8 @@ +{ + '#withTimeIntervals': { ignore: true }, + '#withIntervals': super['#withTimeIntervals'], + withIntervals: super.withTimeIntervals, + '#withTimeIntervalsMixin': { ignore: true }, + '#withIntervalsMixin': super['#withTimeIntervalsMixin'], + withIntervalsMixin: super.withTimeIntervalsMixin, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/notificationPolicy.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/notificationPolicy.libsonnet new file mode 100644 index 0000000..cf9a2b7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/notificationPolicy.libsonnet @@ -0,0 +1,12 @@ +{ + '#withReceiver': { ignore: true }, + '#withContactPoint': super['#withReceiver'], + withContactPoint: super.withReceiver, + + '#withRoutes': { ignore: true }, + '#withPolicy': super['#withRoutes'], + withPolicy: super.withRoutes, + '#withRoutesMixin': { ignore: true }, + '#withPolicyMixin': super['#withRoutesMixin'], + withPolicyMixin: super.withRoutesMixin, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/ruleGroup.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/ruleGroup.libsonnet new file mode 100644 index 0000000..4ed32af --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/alerting/ruleGroup.libsonnet @@ -0,0 +1,13 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + rule+: { + '#':: d.package.newSub('rule', ''), + '#withTitle': { ignore: true }, + '#withName': super['#withTitle'], + withName: super.withTitle, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard.libsonnet new file mode 100644 index 0000000..ea8cb55 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard.libsonnet @@ -0,0 +1,69 @@ +local util = import './util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new dashboard with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withSchemaVersion() + + self.withTimezone('utc') + + self.time.withFrom('now-6h') + + self.time.withTo('now'), + + '#withSchemaVersion': { 'function'+: { args: [d.arg('value', d.T.integer, default=39)] } }, + withSchemaVersion(value=39): { + schemaVersion: value, + }, + + '#withPanels':: d.func.new( + '`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanels(panels, setPanelIDs=true): { + _panels:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + '#withPanelsMixin':: d.func.new( + '`withPanelsMixin` adds more panels to a dashboard.', + args=[ + d.arg('panels', d.T.array), + d.arg('setPanelIDs', d.T.bool, default=true), + ] + ), + withPanelsMixin(panels, setPanelIDs=true): { + _panels+:: if std.isArray(panels) then panels else [panels], + panels: + if setPanelIDs + then util.panel.setPanelIDs(self._panels) + else self._panels, + }, + + graphTooltip+: { + // 0 - Default + // 1 - Shared crosshair + // 2 - Shared tooltip + '#withSharedCrosshair':: d.func.new( + 'Share crosshair on all panels.', + ), + withSharedCrosshair(): + { graphTooltip: 1 }, + + '#withSharedTooltip':: d.func.new( + 'Share crosshair and tooltip on all panels.', + ), + withSharedTooltip(): + { graphTooltip: 2 }, + }, +} ++ (import './dashboard/annotation.libsonnet') ++ (import './dashboard/link.libsonnet') ++ (import './dashboard/variable.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/annotation.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/annotation.libsonnet new file mode 100644 index 0000000..02892ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/annotation.libsonnet @@ -0,0 +1,36 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#annotation':: {}, + + '#withAnnotations': + d.func.new( + ||| + `withAnnotations` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotations(value): super.annotation.withList(value), + + '#withAnnotationsMixin': + d.func.new( + ||| + `withAnnotationsMixin` adds an array of annotations to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withAnnotationsMixin(value): super.annotation.withListMixin(value), + + annotation: + super.annotation.list + + { + '#':: d.package.newSub( + 'annotation', + '', + ), + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/link.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/link.libsonnet new file mode 100644 index 0000000..eb9b2fe --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/link.libsonnet @@ -0,0 +1,90 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withLinks':: d.func.new( + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + `withLinks` takes an array of [link objects](./link.md). + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + [d.arg('value', d.T.array)], + ), + '#withLinksMixin':: self['#withLinks'], + + link+: { + '#':: d.package.newSub( + 'link', + ||| + Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + + The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + + Example: + + ```jsonnet + local g = import 'g.libsonnet'; + local link = g.dashboard.link; + + g.dashboard.new('Title dashboard') + + g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), + ]) + ``` + |||, + ), + + dashboards+: { + '#new':: d.func.new( + ||| + Create links to dashboards based on `tags`. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('tags', d.T.array), + ] + ), + new(title, tags): + self.withTitle(title) + + self.withType('dashboards') + + self.withTags(tags), + + '#withTitle':: {}, + '#withType':: {}, + '#withTags':: {}, + }, + + link+: { + '#new':: d.func.new( + ||| + Create link to an arbitrary URL. + |||, + args=[ + d.arg('title', d.T.string), + d.arg('url', d.T.string), + ] + ), + new(title, url): + self.withTitle(title) + + self.withType('link') + + self.withUrl(url), + + '#withTitle':: {}, + '#withType':: {}, + '#withUrl':: {}, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/variable.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/variable.libsonnet new file mode 100644 index 0000000..b4ce4d3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/dashboard/variable.libsonnet @@ -0,0 +1,525 @@ +local util = import '../util/main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local var = super.variable.list, + + '#withVariables': + d.func.new( + ||| + `withVariables` adds an array of variables to a dashboard + |||, + args=[d.arg('value', d.T.array)] + ), + withVariables(value): super.variable.withList(value), + + '#withVariablesMixin': + d.func.new( + ||| + `withVariablesMixin` adds an array of variables to a dashboard. + + This function appends passed data to existing values + |||, + args=[d.arg('value', d.T.array)] + ), + withVariablesMixin(value): super.variable.withListMixin(value), + + variable: { + '#':: d.package.newSub( + 'variable', + ||| + Example usage: + + ```jsonnet + local g = import 'g.libsonnet'; + local var = g.dashboard.variable; + + local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + + local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + + g.dashboard.new('my dashboard') + + g.dashboard.withVariables([ + customVar, + queryVar, + ]) + ``` + |||, + ), + + local generalOptions = { + generalOptions+: + { + + '#withName': var['#withName'], + withName: var.withName, + '#withLabel': var['#withLabel'], + withLabel: var.withLabel, + '#withDescription': var['#withDescription'], + withDescription: var.withDescription, + + showOnDashboard: { + '#withLabelAndValue':: d.func.new(''), + withLabelAndValue(): var.withHide(0), + '#withValueOnly':: d.func.new(''), + withValueOnly(): var.withHide(1), + '#withNothing':: d.func.new(''), + withNothing(): var.withHide(2), + }, + + '#withCurrent':: d.func.new( + ||| + `withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + |||, + args=[ + d.arg('key', d.T.any), + d.arg('value', d.T.any, default=''), + ] + ), + withCurrent(key, value=key): { + local multi(v) = + if std.get(self, 'multi', false) + && !std.isArray(v) + then [v] + else v, + current: { + selected: false, + text: multi(key), + value: multi(value), + }, + }, + }, + }, + + local selectionOptions = + { + selectionOptions: + { + '#withMulti':: d.func.new( + 'Enable selecting multiple values.', + args=[ + d.arg('value', d.T.boolean, default=true), + ] + ), + withMulti(value=true): { + multi: value, + }, + + '#withIncludeAll':: d.func.new( + ||| + `withIncludeAll` enables an option to include all variables. + + Optionally you can set a `customAllValue`. + |||, + args=[ + d.arg('value', d.T.boolean, default=true), + d.arg('customAllValue', d.T.string, default=null), + ] + ), + withIncludeAll(value=true, customAllValue=null): { + includeAll: value, + [if customAllValue != null then 'allValue']: customAllValue, + }, + }, + }, + + query: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + Create a query template variable. + + `query` argument is optional, this can also be set with `query.queryTypes`. + |||, + args=[ + d.arg('name', d.T.string), + d.arg('query', d.T.string, default=''), + ] + ), + new(name, query=''): + var.withName(name) + + var.withType('query') + + var.withQuery(query), + + '#withDatasource':: d.func.new( + 'Select a datasource for the variable template query.', + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#withDatasourceFromVariable':: d.func.new( + 'Select the datasource from another template variable.', + args=[ + d.arg('variable', d.T.object), + ] + ), + withDatasourceFromVariable(variable): + if variable.type == 'datasource' + then self.withDatasource(variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + '#withRegex':: d.func.new( + ||| + `withRegex` can extract part of a series name or metric node segment. Named + capture groups can be used to separate the display text and value + ([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + + '#withSort':: d.func.new( + ||| + Choose how to sort the values in the dropdown. + + This can be called as `withSort() to use the integer values for each + option. If `i==0` then it will be ignored and the other arguments will take + precedence. + + The numerical values are: + + - 1 - Alphabetical (asc) + - 2 - Alphabetical (desc) + - 3 - Numerical (asc) + - 4 - Numerical (desc) + - 5 - Alphabetical (case-insensitive, asc) + - 6 - Alphabetical (case-insensitive, desc) + |||, + args=[ + d.arg('i', d.T.number, default=0), + d.arg('type', d.T.string, default='alphabetical'), + d.arg('asc', d.T.boolean, default=true), + d.arg('caseInsensitive', d.T.boolean, default=false), + ], + ), + withSort(i=0, type='alphabetical', asc=true, caseInsensitive=false): + if i != 0 // provide fallback to numerical value + then { sort: i } + else + { + local mapping = { + alphabetical: + if !caseInsensitive + then + if asc + then 1 + else 2 + else + if asc + then 5 + else 6, + numerical: + if asc + then 3 + else 4, + }, + sort: mapping[type], + }, + + // TODO: Expand with Query types to match GUI + queryTypes: { + '#withLabelValues':: d.func.new( + 'Construct a Prometheus template variable using `label_values()`.', + args=[ + d.arg('label', d.T.string), + d.arg('metric', d.T.string, default=''), + ] + ), + withLabelValues(label, metric=''): + if metric == '' + then var.withQuery('label_values(%s)' % label) + else var.withQuery('label_values(%s, %s)' % [metric, label]), + + '#withQueryResult':: d.func.new( + 'Construct a Prometheus template variable using `query_result()`.', + args=[ + d.arg('query', d.T.string), + ] + ), + withQueryResult(query): + var.withQuery('query_result(%s)' % query), + }, + + // Deliberately undocumented, use `refresh` below + withRefresh(value): { + // 1 - On dashboard load + // 2 - On time range chagne + refresh: value, + }, + + local withRefresh = self.withRefresh, + refresh+: { + '#onLoad':: d.func.new( + 'Refresh label values on dashboard load.' + ), + onLoad(): withRefresh(1), + + '#onTime':: d.func.new( + 'Refresh label values on time range change.' + ), + onTime(): withRefresh(2), + }, + }, + + custom: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + ||| + `new` creates a custom template variable. + + The `values` array accepts an object with key/value keys, if it's not an object + then it will be added as a string. + + Example: + ``` + [ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, + ] + |||, + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('custom') + + { + // Make values array available in jsonnet + values:: [ + if !std.isObject(item) + then { + key: std.toString(item), + value: std.toString(item), + } + else item + for item in values + ], + + // Render query from values array + query: + std.join(',', [ + std.join(' : ', [item.key, item.value]) + for item in self.values + ]), + + // Set current/options + current: + util.dashboard.getCurrentFromValues( + self.values, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.values), + }, + + withQuery(query): { + values:: util.dashboard.parseCustomQuery(query), + query: query, + }, + }, + + textbox: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a textbox template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('default', d.T.string, default=''), + ] + ), + new(name, default=''): + var.withName(name) + + var.withType('textbox') + + { + local this = self, + default:: default, + query: self.default, + + // Set current/options + keyvaluedict:: [{ key: this.query, value: this.query }], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + }, + + constant: + generalOptions + + { + '#new':: d.func.new( + '`new` creates a hidden constant template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('value', d.T.string), + ] + ), + new(name, value=''): + var.withName(name) + + var.withType('constant') + + var.withHide(2) + + var.withQuery(value), + }, + + datasource: + generalOptions + + selectionOptions + + { + '#new':: d.func.new( + '`new` creates a datasource template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + ] + ), + new(name, type): + var.withName(name) + + var.withType('datasource') + + var.withQuery(type), + + '#withRegex':: d.func.new( + ||| + `withRegex` filter for which data source instances to choose from in the + variable value list. Example: `/^prod/` + |||, + args=[ + d.arg('value', d.T.string), + ] + ), + withRegex(value): { + regex: value, + }, + }, + + interval: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an interval template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('values', d.T.array), + ] + ), + new(name, values): + var.withName(name) + + var.withType('interval') + + { + // Make values array available in jsonnet + values:: values, + // Render query from values array + query: std.join(',', self.values), + + // Set current/options + keyvaluedict:: [ + { + key: item, + value: item, + } + for item in values + ], + current: + util.dashboard.getCurrentFromValues( + self.keyvaluedict, + std.get(self, 'multi', false) + ), + options: util.dashboard.getOptionsFromValues(self.keyvaluedict), + }, + + + '#withAutoOption':: d.func.new( + ||| + `withAutoOption` adds an options to dynamically calculate interval by dividing + time range by the count specified. + + `minInterval' has to be either unit-less or end with one of the following units: + "y, M, w, d, h, m, s, ms". + |||, + args=[ + d.arg('count', d.T.number), + d.arg('minInterval', d.T.string), + ] + ), + withAutoOption(count=30, minInterval='10s'): { + local this = self, + + auto: true, + auto_count: count, + auto_min: minInterval, + + // Add auto item to current/options + keyvaluedict:: + [{ key: 'auto', value: '$__auto_interval_' + this.name }] + + super.keyvaluedict, + }, + }, + + adhoc: + generalOptions + + { + '#new':: d.func.new( + '`new` creates an adhoc template variable for datasource with `type` and `uid`.', + args=[ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + new(name, type, uid): + var.withName(name) + + var.withType('adhoc') + + var.datasource.withType(type) + + var.datasource.withUid(uid), + + '#newFromDatasourceVariable':: d.func.new( + 'Same as `new` but selecting the datasource from another template variable.', + args=[ + d.arg('name', d.T.string), + d.arg('variable', d.T.object), + ] + ), + newFromDatasourceVariable(name, variable): + if variable.type == 'datasource' + then self.new(name, variable.query, '${%s}' % variable.name) + else error "`variable` not of type 'datasource'", + + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/panel.libsonnet new file mode 100644 index 0000000..240a044 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/panel.libsonnet @@ -0,0 +1,171 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +// match name/title to reduce diff in docs +local panelNames = { + alertgroups: 'alertGroups', + annolist: 'annotationsList', + barchart: 'barChart', + bargauge: 'barGauge', + dashlist: 'dashboardList', + nodeGraph: 'nodeGraph', + piechart: 'pieChart', + 'state-timeline': 'stateTimeline', + 'status-history': 'statusHistory', + timeseries: 'timeSeries', + xychart: 'xyChart', +}; + +local getPanelName(type) = + std.get(panelNames, type, type); + +{ + '#new':: d.func.new( + 'Creates a new %s panel with a title.' % getPanelName(self.panelOptions.withType().type), + args=[d.arg('title', d.T.string)] + ), + new(title): + self.panelOptions.withTitle(title) + + self.panelOptions.withType() + + self.panelOptions.withPluginVersion() + // Default to Mixed datasource so panels can be datasource agnostic, this + // requires query targets to explicitly set datasource, which is a lot more + // interesting from a reusability standpoint. + + self.queryOptions.withDatasource('datasource', '-- Mixed --'), + + // Backwards compatible entries, ignored in docs + link+: self.panelOptions.link + { '#':: { ignore: true } }, + thresholdStep+: self.standardOptions.threshold.step + { '#':: { ignore: true } }, + transformation+: self.queryOptions.transformation + { '#':: { ignore: true } }, + valueMapping+: self.standardOptions.mapping + { '#':: { ignore: true } }, + fieldOverride+: self.standardOptions.override + { '#':: { ignore: true } }, + + '#gridPos': {}, // use withGridPos instead, a bit more concise. + local gridPos = self.gridPos, + panelOptions+: { + '#withPluginVersion': {}, + + '#withGridPos': d.func.new( + ||| + `withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + + All arguments default to `null`, which means they will remain unchanged or unset. + |||, + args=[ + d.arg('h', d.T.number, default='null'), + d.arg('w', d.T.number, default='null'), + d.arg('x', d.T.number, default='null'), + d.arg('y', d.T.number, default='null'), + ] + ), + withGridPos(h=null, w=null, x=null, y=null): + (if h != null then gridPos.withH(h) else {}) + + (if w != null then gridPos.withW(w) else {}) + + (if x != null then gridPos.withX(x) else {}) + + (if y != null then gridPos.withY(y) else {}), + }, + + '#datasource':: {}, // use withDatasource instead, bit more concise + local datasource = self.datasource, + queryOptions+: { + '#withDatasource':: d.func.new( + ||| + `withDatasource` sets the datasource for all queries in a panel. + + The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + |||, + args=[ + d.arg('type', d.T.string), + d.arg('uid', d.T.string), + ] + ), + withDatasource(type, uid): + datasource.withType(type) + + datasource.withUid(uid), + }, + + standardOptions+: { + threshold+: { step+: { '#':: d.package.newSub('threshold.step', '') } }, + + local overrides = super.override, + local commonOverrideFunctions = { + '#new':: d.fn( + '`new` creates a new override of type `%s`.' % self.type, + args=[ + d.arg('value', d.T.string), + ] + ), + new(value): + overrides.matcher.withId(self.type) + + overrides.matcher.withOptions(value), + + '#withProperty':: d.fn( + ||| + `withProperty` adds a property that needs to be overridden. This function can + be called multiple time, adding more properties. + |||, + args=[ + d.arg('id', d.T.string), + d.arg('value', d.T.any), + ] + ), + withProperty(id, value): + overrides.withPropertiesMixin([ + overrides.properties.withId(id) + + overrides.properties.withValue(value), + ]), + + '#withPropertiesFromOptions':: d.fn( + ||| + `withPropertiesFromOptions` takes an object with properties that need to be + overridden. See example code above. + |||, + args=[ + d.arg('options', d.T.object), + ] + ), + withPropertiesFromOptions(options): + local infunc(input, path=[]) = + std.foldl( + function(acc, p) + acc + ( + if p == 'custom' + then infunc(input[p], path=path + [p]) + else + overrides.withPropertiesMixin([ + overrides.properties.withId(std.join('.', path + [p])) + + overrides.properties.withValue(input[p]), + ]) + ), + std.objectFields(input), + {} + ); + infunc(options.fieldConfig.defaults), + }, + + override: + { + '#':: d.package.newSub( + 'override', + ||| + Overrides allow you to customize visualization settings for specific fields or + series. This is accomplished by adding an override rule that targets + a particular set of fields and that can each define multiple options. + + ```jsonnet + override.byType.new('number') + + override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') + ) + ``` + ||| + ), + byName: commonOverrideFunctions + { type:: 'byName' }, + byRegexp: commonOverrideFunctions + { type:: 'byRegexp' }, + byType: commonOverrideFunctions + { type:: 'byType' }, + byQuery: commonOverrideFunctions + { type:: 'byFrameRefID' }, + // TODO: byValue takes more complex `options` than string + byValue: commonOverrideFunctions + { type:: 'byValue' }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/azureMonitor.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/azureMonitor.libsonnet new file mode 100644 index 0000000..8926449 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/azureMonitor.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafana-azure-monitor-datasource', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/cloudWatch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/cloudWatch.libsonnet new file mode 100644 index 0000000..208ee65 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/cloudWatch.libsonnet @@ -0,0 +1,23 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local withDatasourceStub = { + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloudwatch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, + }, + + CloudWatchAnnotationQuery+: withDatasourceStub, + CloudWatchLogsQuery+: withDatasourceStub, + CloudWatchMetricsQuery+: withDatasourceStub, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/elasticsearch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/elasticsearch.libsonnet new file mode 100644 index 0000000..7d1d54a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/elasticsearch.libsonnet @@ -0,0 +1,20 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + bucketAggs+: { '#': { help: '', name: 'bucketAggs' } }, + metrics+: { '#': { help: '', name: 'metrics' } }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'elasticsearch', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/expr.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/expr.libsonnet new file mode 100644 index 0000000..02417b6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/expr.libsonnet @@ -0,0 +1,12 @@ +{ + '#': { + help: 'Server Side Expression operations for grafonnet.alerting.ruleGroup.rule', + name: 'expr', + }, + TypeMath+: { '#': { help: 'grafonnet.query.expr.TypeMath', name: 'TypeMath' } }, + TypeReduce+: { '#': { help: 'grafonnet.query.expr.TypeReduce', name: 'TypeReduce' } }, + TypeResample+: { '#': { help: 'grafonnet.query.expr.TypeResample', name: 'TypeResample' } }, + TypeClassicConditions+: { '#': { help: 'grafonnet.query.expr.TypeClassicConditions', name: 'TypeClassicConditions' } }, + TypeThreshold+: { '#': { help: 'grafonnet.query.expr.TypeThreshold', name: 'TypeThreshold' } }, + TypeSql+: { '#': { help: 'grafonnet.query.expr.TypeSql', name: 'TypeSql' } }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/googleCloudMonitoring.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/googleCloudMonitoring.libsonnet new file mode 100644 index 0000000..1adaa99 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'cloud-monitoring', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/grafanaPyroscope.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/grafanaPyroscope.libsonnet new file mode 100644 index 0000000..2f52821 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/grafanaPyroscope.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'grafanapyroscope', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/loki.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/loki.libsonnet new file mode 100644 index 0000000..4831145 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/loki.libsonnet @@ -0,0 +1,28 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new loki query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'loki', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/parca.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/parca.libsonnet new file mode 100644 index 0000000..35c454e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/parca.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'parca', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/prometheus.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/prometheus.libsonnet new file mode 100644 index 0000000..68e1e05 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/prometheus.libsonnet @@ -0,0 +1,48 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new prometheus query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('expr', d.T.string), + ] + ), + new(datasource, expr): + self.withDatasource(datasource) + + self.withExpr(expr), + + '#withIntervalFactor':: d.func.new( + 'Set the interval factor for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withIntervalFactor(value): { + intervalFactor: value, + }, + + '#withLegendFormat':: d.func.new( + 'Set the legend format for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withLegendFormat(value): { + legendFormat: value, + }, + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'prometheus', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/tempo.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/tempo.libsonnet new file mode 100644 index 0000000..f9fc910 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/tempo.libsonnet @@ -0,0 +1,30 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new tempo query target for panels.', + args=[ + d.arg('datasource', d.T.string), + d.arg('query', d.T.string), + d.arg('filters', d.T.array), + ] + ), + new(datasource, query, filters): + self.withDatasource(datasource) + + self.withQuery(query) + + self.withFilters(filters), + + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(value): { + datasource+: { + type: 'tempo', + uid: value, + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/testData.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/testData.libsonnet new file mode 100644 index 0000000..b482dbc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/query/testData.libsonnet @@ -0,0 +1,17 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#withDatasource':: d.func.new( + 'Set the datasource for this query.', + args=[ + d.arg('value', d.T.string), + ] + ), + withDatasource(): { + datasource+: { + type: 'datasource', + uid: 'grafana', + }, + }, + '#withDatasourceMixin':: { ignore: true }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/row.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/row.libsonnet new file mode 100644 index 0000000..049537e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/row.libsonnet @@ -0,0 +1,26 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#new':: d.func.new( + 'Creates a new row panel with a title.', + args=[d.arg('title', d.T.string)] + ), + new(title): + self.withTitle(title) + + self.withType() + + self.withCollapsed(false) + + self.gridPos.withX(0) + + self.gridPos.withH(1) + + self.gridPos.withW(24), + + '#gridPos':: {}, // use withGridPos instead + '#withGridPos':: d.func.new( + '`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values.', + args=[d.arg('y', d.T.number)] + ), + withGridPos(y): + self.gridPos.withX(0) + + self.gridPos.withY(y) + + self.gridPos.withH(1) + + self.gridPos.withW(24), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/dashboard.libsonnet new file mode 100644 index 0000000..da7b2c8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/dashboard.libsonnet @@ -0,0 +1,55 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local root = self, + + '#getOptionsForCustomQuery':: d.func.new( + ||| + `getOptionsForCustomQuery` provides values for the `options` and `current` fields. + These are required for template variables of type 'custom'but do not automatically + get populated by Grafana when importing a dashboard from JSON. + + This is a bit of a hack and should always be called on functions that set `type` on + a template variable. Ideally Grafana populates these fields from the `query` value + but this provides a backwards compatible solution. + |||, + args=[d.arg('query', d.T.string)], + ), + getOptionsForCustomQuery(query, multi): { + local values = root.parseCustomQuery(query), + current: root.getCurrentFromValues(values, multi), + options: root.getOptionsFromValues(values), + }, + + getCurrentFromValues(values, multi): { + selected: false, + text: if multi then [values[0].key] else values[0].key, + value: if multi then [values[0].value] else values[0].value, + }, + + getOptionsFromValues(values): + std.mapWithIndex( + function(i, item) { + selected: i == 0, + text: item.key, + value: item.value, + }, + values + ), + + parseCustomQuery(query): + std.map( + function(v) + // Split items into key:value pairs + local split = std.splitLimit(v, ' : ', 1); + { + key: std.stripChars(split[0], ' '), + value: + if std.length(split) == 2 + then std.stripChars(split[1], ' ') + else self.key, + }, + xtd.string.splitEscape(query, ',') // Split query by comma, unless the comma is escaped + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/grid.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/grid.libsonnet new file mode 100644 index 0000000..8214cdd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/grid.libsonnet @@ -0,0 +1,212 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +local panelUtil = import './panel.libsonnet'; + +{ + local root = self, + + local gridWidth = 24, + + '#makeGrid':: d.func.new( + ||| + `makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` + and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, + then all panels below it will be folded into the row. + + This function will use the full grid of 24 columns, setting `panelWidth` to a value + that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) + Other value for `panelWidth` will leave a gap on the far right. + + Optional `startY` can be provided to place generated grid above or below existing panels. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + makeGrid(panels, panelWidth=8, panelHeight=8, startY=0): + local sanitizePanels(ps) = std.map( + function(p) + local sanePanel = panelUtil.sanitizePanel(p); + ( + if p.type == 'row' + then sanePanel + { + panels: sanitizePanels(sanePanel.panels), + } + else sanePanel + { + gridPos+: { + h: panelHeight, + w: panelWidth, + }, + } + ), + ps + ); + + local sanitizedPanels = sanitizePanels(panels); + + local grouped = panelUtil.groupPanelsInRows(sanitizedPanels); + + local panelsBeforeRows = panelUtil.getPanelsBeforeNextRow(grouped); + local rowPanels = + std.filter( + function(p) p.type == 'row', + grouped + ); + + local CalculateXforPanel(index, panel) = + local panelsPerRow = std.floor(gridWidth / panelWidth); + local col = std.mod(index, panelsPerRow); + panel + { gridPos+: { x: panelWidth * col } }; + + local panelsBeforeRowsWithX = std.mapWithIndex(CalculateXforPanel, panelsBeforeRows); + + local rowPanelsWithX = + std.map( + function(row) + row + { panels: std.mapWithIndex(CalculateXforPanel, row.panels) }, + rowPanels + ); + + local uncollapsed = panelUtil.resolveCollapsedFlagOnRows(panelsBeforeRowsWithX + rowPanelsWithX); + + local normalized = panelUtil.normalizeY(uncollapsed); + + std.map(function(p) p + { gridPos+: { y+: startY } }, normalized), + + '#wrapPanels':: d.func.new( + ||| + `wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. + 'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('panelWidth', d.T.number), + d.arg('panelHeight', d.T.number), + d.arg('startY', d.T.number), + ], + ), + wrapPanels(panels, panelWidth=8, panelHeight=8, startY=0): + + local calculateGridPosForPanel(acc, panel) = + local gridPos = std.get(panel, 'gridPos', {}); + local width = std.get(gridPos, 'w', panelWidth); + local height = std.get(gridPos, 'h', panelHeight); + if acc.cursor.x + width > gridWidth + then + // start new row as width exceeds gridWidth + { + panels+: [ + panel + { + gridPos+: + { + x: 0, + y: acc.cursor.y + height, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: 0 + width, + y: acc.cursor.y + height, + maxH: if height > acc.cursor.maxH then height else acc.cursor.maxH, + }, + } + else + // enough width, place panel on current row + { + panels+: [ + panel + { + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y, + w: width, + h: height, + }, + }, + ], + cursor+:: { + x: acc.cursor.x + width, + y: acc.cursor.y, + maxH: if height > acc.cursor.maxH then height else acc.cursor.maxH, + }, + }; + + std.foldl( + function(acc, panel) + if panel.type == 'row' + then + ( + if std.objectHas(panel, 'panels') && std.length(panel.panels) > 0 + then + local rowPanels = + std.foldl( + function(acc, panel) + acc + calculateGridPosForPanel(acc, panel), + panel.panels, + { + panels+: [], + // initial + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + }, + ); + acc + { + panels+: [ + panel + { + //rows panels + panels: rowPanels.panels, + gridPos+: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + }, + + }, + ], + cursor:: rowPanels.cursor, + } + else + acc + { + panels+: [ + panel + { + panels: [], + gridPos+: + { + x: acc.cursor.x, + y: acc.cursor.y + acc.cursor.maxH, + w: 0, + h: 1, + }, + }, + ], + cursor:: { + x: 0, + y: acc.cursor.y + acc.cursor.maxH + 1, + maxH: 0, + }, + } + ) + else + // handle regular panel + acc + calculateGridPosForPanel(acc, panel), + panels, + // Initial value for acc: + { + panels: [], + cursor:: { + x: 0, + y: startY, + maxH: 0, // max height of current 'row' + }, + } + ).panels, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/main.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/main.libsonnet new file mode 100644 index 0000000..78fe95f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/main.libsonnet @@ -0,0 +1,9 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.package.newSub('util', 'Helper functions that work well with Grafonnet.'), + dashboard: (import './dashboard.libsonnet'), + grid: (import './grid.libsonnet'), + panel: (import './panel.libsonnet'), + string: (import './string.libsonnet'), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/panel.libsonnet new file mode 100644 index 0000000..89e0bd7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/panel.libsonnet @@ -0,0 +1,420 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + local this = self, + + // used in ../dashboard.libsonnet + '#setPanelIDs':: d.func.new( + ||| + `setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + + `overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + |||, + args=[ + d.arg('panels', d.T.array), + d.arg('overrideExistingIDs', d.T.bool, default=true), + ] + ), + setPanelIDs(panels, overrideExistingIDs=true): + local infunc(panels, start=1) = + std.foldl( + function(acc, panel) + acc + { + index: // Track the index to ensure no duplicates exist. + acc.index + + 1 + + (if panel.type == 'row' + && 'panels' in panel + then std.length(panel.panels) + else 0), + + panels+: [ + panel + + ( + if overrideExistingIDs + || std.get(panel, 'id', null) == null + then { id: acc.index } + else {} + ) + + ( + if panel.type == 'row' + && 'panels' in panel + then { + panels: + infunc( + panel.panels, + acc.index + 1 + ), + } + else {} + ), + ], + }, + panels, + { index: start, panels: [] } + ).panels; + infunc(panels), + + '#getPanelIDs':: d.func.new( + ||| + `getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + getPanelIDs(panels): + std.flattenArrays( + std.map( + function(panel) + [panel.id] + + (if panel.type == 'row' + then this.getPanelIDs(std.get(panel, 'panels', [])) + else []), + panels + ) + ), + + '#validatePanelIDs':: d.func.new( + ||| + `validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + validatePanelIDs(panels): + local ids = this.getPanelIDs(panels); + std.set(ids) == std.sort(ids), + + '#sanitizePanel':: d.func.new( + ||| + `sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + + The default values for x,y,h,w are only applied if not already set. + |||, + [ + d.arg('panel', d.T.object), + d.arg('defaultX', d.T.number, default=0), + d.arg('defaultY', d.T.number, default=0), + d.arg('defaultHeight', d.T.number, default=8), + d.arg('defaultWidth', d.T.number, default=8), + ] + ), + sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8): + local infunc(panel) = + panel + + ( + local gridPos = std.get(panel, 'gridPos', {}); + if panel.type == 'row' + then { + collapsed: std.get(panel, 'collapsed', false), + panels: std.map(infunc, std.get(panel, 'panels', [])), + gridPos: { // x, h, w are fixed + x: 0, + y: std.get(gridPos, 'y', defaultY), + h: 1, + w: 24, + }, + } + else { + gridPos: { + x: std.get(gridPos, 'x', defaultX), + y: std.get(gridPos, 'y', defaultY), + h: std.get(gridPos, 'h', defaultHeight), + w: std.get(gridPos, 'w', defaultWidth), + }, + } + ); + infunc(panel), + + '#sortPanelsByXY':: d.func.new( + ||| + `sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + sortPanelsByXY(panels): + std.sort( + std.sort( + panels, + function(panel) + panel.gridPos.x + ), + function(panel) + panel.gridPos.y + ), + + '#sortPanelsInRow':: d.func.new( + ||| + `sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + sortPanelsInRow(rowPanel): + rowPanel + { panels: this.sortPanelsByXY(rowPanel.panels) }, + + '#groupPanelsInRows':: d.func.new( + ||| + `groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + groupPanelsInRows(panels): + // Add panels that come after a row to row.panels + local grouped = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) + p + { + panels+: + this.getPanelsBeforeNextRow(panels[i + 1:]), + }, + panels, + ); + + // Get panels that come before the rowGroups + local panelsBeforeRowGroups = this.getPanelsBeforeNextRow(panels); + + panelsBeforeRowGroups + grouped, + + '#getPanelsBeforeNextRow':: d.func.new( + ||| + `getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + getPanelsBeforeNextRow(panels): + local rowIndexes = + xtd.array.filterMapWithIndex( + function(i, p) p.type == 'row', + function(i, p) i, + panels, + ); + if std.length(rowIndexes) != 0 + then panels[0:rowIndexes[0]] + else panels[0:], // if no row panels found, return all remaining panels + + '#resolveCollapsedFlagOnRows':: d.func.new( + ||| + `resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + resolveCollapsedFlagOnRows(panels): + std.foldl( + function(acc, panel) + acc + ( + if panel.type == 'row' + && !panel.collapsed + then // If not collapsed, then move panels to main array below the row panel + [panel + { panels: [] }] + + panel.panels + else [panel] + ), + panels, + [], + ), + + '#normalizeY':: d.func.new( + ||| + `normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + + This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + |||, + [ + d.arg('panels', d.T.array), + ] + ), + normalizeY(panels): + std.foldl( + function(acc, i) + acc + [ + panels[i] + { + gridPos+: { + y: this.calculateLowestYforPanel(panels[i], acc), + }, + }, + ], + std.range(0, std.length(panels) - 1), + [] + ), + + '#calculateLowestYforPanel':: d.func.new( + ||| + `calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + |||, + [ + d.arg('panel', d.T.object), + d.arg('panels', d.T.array), + ] + ), + calculateLowestYforPanel(panel, panels): + xtd.number.maxInArray( // the new position is highest value (max) on the Y-scale + std.filterMap( + function(p) // find panels that overlap on X-scale + local v1 = panel.gridPos.x; + local v2 = panel.gridPos.x + panel.gridPos.w; + local x1 = p.gridPos.x; + local x2 = p.gridPos.x + p.gridPos.w; + (v1 >= x1 && v1 < x2) + || (v2 >= x1 && v2 < x2), + function(p) // return new position on Y-scale + p.gridPos.y + p.gridPos.h, + panels, + ), + ), + + '#normalizeYInRow':: d.func.new( + ||| + `normalizeYInRow` applies `normalizeY` to the panels in a row panel. + |||, + [ + d.arg('rowPanel', d.T.object), + ] + ), + normalizeYInRow(rowPanel): + rowPanel + { + panels: + std.map( + function(p) + p + { + gridPos+: { + y: // Increase panel Y with the row Y to put them below the row when not collapsed. + p.gridPos.y + + rowPanel.gridPos.y + + rowPanel.gridPos.h, + }, + }, + this.normalizeY(rowPanel.panels) + ), + }, + + '#mapToRows':: d.func.new( + ||| + `mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + |||, + [ + d.arg('func', d.T.func), + d.arg('panels', d.T.array), + ] + ), + mapToRows(func, panels): + std.map( + function(p) + if p.type == 'row' + then func(p) + else p, + panels + ), + + + '#setRefIDs':: d.func.new( + ||| + `setRefIDs` calculates the `refId` field for each target on a panel. + |||, + args=[ + d.arg('panel', d.T.object), + d.arg('overrideExistingIDs', d.T.bool, default=true), + ] + ), + setRefIDs(panel, overrideExistingIDs=true): + local calculateRefID(n) = + // From: https://github.com/grafana/grafana/blob/bffd87107b786930edd091060143ee013843efac/packages/grafana-data/src/query/refId.ts#L15 + local letters = std.map(std.char, std.range(std.codepoint('A'), std.codepoint('Z'))); + if n < std.length(letters) + then letters[n] + else calculateRefID(std.floor(n / std.length(letters)) - 1) + letters[std.mod(n, std.length(letters))]; + panel + { + targets: + std.mapWithIndex( + function(i, target) + if overrideExistingIDs + || !std.objectHas(target, 'refId') + then target + { + refId: calculateRefID(i), + } + else target, + panel.targets, + ), + }, + + '#setRefIDsOnPanels':: d.func.new( + ||| + `setRefIDsOnPanels` applies `setRefIDs on all `panels`. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + setRefIDsOnPanels(panels): + std.map(self.setRefIDs, panels), + + '#dedupeQueryTargets':: d.func.new( + ||| + `dedupeQueryTargets` dedupes the query targets in a set of panels and replaces the duplicates with a ['shared query'](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/share-query/). Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard. + + This function requires that the query targets have `refId` set, `setRefIDs` and `setRefIDsOnPanels` can help with that. + |||, + args=[ + d.arg('panels', d.T.array), + ] + ), + dedupeQueryTargets(panels): + // Hide ref so it doesn't compare in equality + local targetWithoutRef(target) = + target + { refId:: target.refId }; + + // Find targets that are the same + local findTargets(targets, target) = + std.filter( + function(t) + targetWithoutRef(t) == targetWithoutRef(target), + targets + ); + + // Get a flat array of all targets including their panelId + local targets = std.flattenArrays([ + std.map(function(t) t + { panelId:: panel.id }, panel.targets) + for panel in panels + ]); + + std.map( + function(panel) + // Replace target with 'shared query' target if found in other panels + local replaceTarget(target) = + local found = findTargets(targets, target); + if std.length(found) > 0 + // Do not reference queries from the same panel + && found[0].panelId != panel.id + then { + datasource: { + type: 'datasource', + uid: '-- Dashboard --', + }, + refId: found[0].refId, + panelId: found[0].panelId, + } + else target; + + panel + { + targets: + std.map( + replaceTarget, + panel.targets, + ), + }, + panels + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/string.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/string.libsonnet new file mode 100644 index 0000000..ec5a66e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/custom/util/string.libsonnet @@ -0,0 +1,27 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; + +{ + '#slugify':: d.func.new( + ||| + `slugify` will create a simple slug from `string`, keeping only alphanumeric + characters and replacing spaces with dashes. + |||, + args=[d.arg('string', d.T.string)] + ), + slugify(string): + std.strReplace( + std.asciiLower( + std.join('', [ + string[i] + for i in std.range(0, std.length(string) - 1) + if xtd.ascii.isUpper(string[i]) + || xtd.ascii.isLower(string[i]) + || xtd.ascii.isNumber(string[i]) + || string[i] == ' ' + ]) + ), + ' ', + '-', + ), +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/dashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/dashboard.libsonnet new file mode 100644 index 0000000..f5ea115 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/dashboard.libsonnet @@ -0,0 +1,596 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.dashboard', name: 'dashboard' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of dashboard.' } }, + withDescription(value): { + description: value, + }, + '#withEditable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether a dashboard is editable or not.' } }, + withEditable(value=true): { + editable: value, + }, + '#withFiscalYearStartMonth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'The month that the fiscal year starts on. 0 = January, 11 = December' } }, + withFiscalYearStartMonth(value=0): { + fiscalYearStartMonth: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Links with references to other dashboards or external websites.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLiveNow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When set to true, the dashboard will redraw panels at an interval matching the pixel width.\nThis will keep data "moving left" regardless of the query refresh rate. This setting helps\navoid dashboards presenting stale live data' } }, + withLiveNow(value=true): { + liveNow: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d".' } }, + withRefresh(value): { + refresh: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: 39, enums: null, name: 'value', type: ['integer'] }], help: 'Version of the JSON schema, incremented each time a Grafana update brings\nchanges to said schema.' } }, + withSchemaVersion(value=39): { + schemaVersion: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Tags associated with dashboard.' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTemplating': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplating(value): { + templating: value, + }, + '#withTemplatingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configured template variables' } }, + withTemplatingMixin(value): { + templating+: value, + }, + '#withTimezone': { 'function': { args: [{ default: 'browser', enums: null, name: 'value', type: ['string'] }], help: 'Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc".' } }, + withTimezone(value='browser'): { + timezone: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title of dashboard.' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique dashboard identifier that can be generated by anyone. string (8-40)' } }, + withUid(value): { + uid: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday".' } }, + withWeekStart(value): { + weekStart: value, + }, + time+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value='now-6h'): { + time+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTo(value='now'): { + time+: { + to: value, + }, + }, + }, + timepicker+: + { + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether timepicker is visible or not.' } }, + withHidden(value=true): { + timepicker+: { + hidden: value, + }, + }, + '#withNowDelay': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values.' } }, + withNowDelay(value): { + timepicker+: { + nowDelay: value, + }, + }, + '#withRefreshIntervals': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervals(value): { + timepicker+: { + refresh_intervals: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withRefreshIntervalsMixin': { 'function': { args: [{ default: ['5s', '10s', '30s', '1m', '5m', '15m', '30m', '1h', '2h', '1d'], enums: null, name: 'value', type: ['array'] }], help: 'Interval options available in the refresh picker dropdown.' } }, + withRefreshIntervalsMixin(value): { + timepicker+: { + refresh_intervals+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptions': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptions(value): { + timepicker+: { + time_options: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeOptionsMixin': { 'function': { args: [{ default: ['5m', '15m', '1h', '6h', '12h', '24h', '2d', '7d', '30d'], enums: null, name: 'value', type: ['array'] }], help: 'Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard.' } }, + withTimeOptionsMixin(value): { + timepicker+: { + time_options+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + link+: + { + dashboards+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + link+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + options+: + { + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + }, + }, + }, + annotation+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withList(value): { + annotations+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of annotations' } }, + withListMixin(value): { + annotations+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withBuiltIn': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Set to 1 for the standard annotation query all dashboards have by default.' } }, + withBuiltIn(value=0): { + builtIn: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEnable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled the annotation query is issued with every dashboard refresh' } }, + withEnable(value=true): { + enable: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpr(value): { + expr: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Filters to apply when fetching annotations' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Filters to apply when fetching annotations' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withExclude': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Should the specified panels be included or excluded' } }, + withExclude(value=true): { + filter+: { + exclude: value, + }, + }, + '#withIds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIds(value): { + filter+: { + ids: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withIdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel IDs that should be included or excluded' } }, + withIdsMixin(value): { + filter+: { + ids+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Annotation queries can be toggled on or off at the top of the dashboard.\nWhen hide is true, the toggle is not shown in the dashboard.' } }, + withHide(value=true): { + hide: value, + }, + '#withIconColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color to use for the annotation event markers' } }, + withIconColor(value): { + iconColor: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of annotation.' } }, + withName(value): { + name: value, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: this should be a regular DataQuery that depends on the selected dashboard\nthese match the properties of the "grafana" datasouce that is default in most dashboards' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withLimit(value): { + target+: { + limit: value, + }, + }, + '#withMatchAny': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withMatchAny(value=true): { + target+: { + matchAny: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTags(value): { + target+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withTagsMixin(value): { + target+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only required/valid for the grafana datasource...\nbut code+tests is already depending on it so hard to change' } }, + withType(value): { + target+: { + type: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TODO -- this should not exist here, it is based on the --grafana-- datasource' } }, + withType(value): { + type: value, + }, + }, + }, + variable+: + { + '#withList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withList(value): { + templating+: { + list: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of configured template variables with their saved values along with some other metadata' } }, + withListMixin(value): { + templating+: { + list+: + (if std.isArray(value) + then value + else [value]), + }, + }, + list+: + { + '#': { help: '', name: 'list' }, + '#withAllValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Custom all value' } }, + withAllValue(value): { + allValue: value, + }, + '#withAuto': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Dynamically calculates interval by dividing time range by the count specified.' } }, + withAuto(value=true): { + auto: value, + }, + '#withAutoCount': { 'function': { args: [{ default: 30, enums: null, name: 'value', type: ['integer'] }], help: 'How many times the current time range should be divided to calculate the value, similar to the Max data points query option.\nFor example, if the current visible time range is 30 minutes, then the auto interval groups the data into 30 one-minute increments.' } }, + withAutoCount(value=30): { + auto_count: value, + }, + '#withAutoMin': { 'function': { args: [{ default: '10s', enums: null, name: 'value', type: ['string'] }], help: 'The minimum threshold below which the step count intervals will not divide the time.' } }, + withAutoMin(value='10s'): { + auto_min: value, + }, + '#withCurrent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrent(value): { + current: value, + }, + '#withCurrentMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Option to be selected in a variable.' } }, + withCurrentMixin(value): { + current+: value, + }, + current+: + { + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + current+: { + selected: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + current+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + current+: { + text+: value, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + current+: { + value: value, + }, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + current+: { + value+: value, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Description of variable. It can be defined but `null`.' } }, + withDescription(value): { + description: value, + }, + '#withHide': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Determine if the variable shows on dashboard\nAccepted values are 0 (show label and value), 1 (show value only), 2 (show nothing).' } }, + withHide(value): { + hide: value, + }, + '#withIncludeAll': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether all value option is available or not' } }, + withIncludeAll(value=true): { + includeAll: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display name' } }, + withLabel(value): { + label: value, + }, + '#withMulti': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether multiple values can be selected or not from variable value list' } }, + withMulti(value=true): { + multi: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of variable' } }, + withName(value): { + name: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptions(value): { + options: + (if std.isArray(value) + then value + else [value]), + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Options that can be selected for a variable.' } }, + withOptionsMixin(value): { + options+: + (if std.isArray(value) + then value + else [value]), + }, + options+: + { + '#': { help: '', name: 'options' }, + '#withSelected': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the option is selected or not' } }, + withSelected(value=true): { + selected: value, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withText(value): { + text: value, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Text to be displayed for the option' } }, + withTextMixin(value): { + text+: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Value of the option' } }, + withValueMixin(value): { + value+: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: 'Query used to fetch values for a variable' } }, + withQueryMixin(value): { + query+: value, + }, + '#withRefresh': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: 'Options to config when to refresh a variable\n`0`: Never refresh the variable\n`1`: Queries the data source every time the dashboard loads.\n`2`: Queries the data source when the dashboard time range changes.' } }, + withRefresh(value): { + refresh: value, + }, + '#withRegex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional field, if you want to extract part of a series name or metric node segment.\nNamed capture groups can be used to separate the display text and value.' } }, + withRegex(value): { + regex: value, + }, + '#withSkipUrlSync': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether the variable value should be managed by URL query params or not' } }, + withSkipUrlSync(value=true): { + skipUrlSync: value, + }, + '#withSort': { 'function': { args: [{ default: null, enums: [0, 1, 2, 3, 4, 5, 6, 7, 8], name: 'value', type: ['string'] }], help: 'Sort variable options\nAccepted values are:\n`0`: No sorting\n`1`: Alphabetical ASC\n`2`: Alphabetical DESC\n`3`: Numerical ASC\n`4`: Numerical DESC\n`5`: Alphabetical Case Insensitive ASC\n`6`: Alphabetical Case Insensitive DESC\n`7`: Natural ASC\n`8`: Natural DESC' } }, + withSort(value): { + sort: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['query', 'adhoc', 'groupby', 'constant', 'datasource', 'interval', 'textbox', 'custom', 'system', 'snapshot'], name: 'value', type: ['string'] }], help: 'Dashboard variable type\n`query`: Query-generated list of values such as metric names, server names, sensor IDs, data centers, and so on.\n`adhoc`: Key/value filters that are automatically added to all metric queries for a data source (Prometheus, Loki, InfluxDB, and Elasticsearch only).\n`constant`: \tDefine a hidden constant.\n`datasource`: Quickly change the data source for an entire dashboard.\n`interval`: Interval variables represent time spans.\n`textbox`: Display a free text input field with an optional default value.\n`custom`: Define the variable options manually using a comma-separated list.\n`system`: Variables defined by Grafana. See: https://grafana.com/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables' } }, + withType(value): { + type: value, + }, + }, + }, +} ++ (import 'custom/dashboard.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/README.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/README.md new file mode 100644 index 0000000..0d5de82 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/README.md @@ -0,0 +1,31 @@ +# grafonnet + +Jsonnet library for rendering Grafana resources +## Install + +``` +jb install github.com/grafana/grafonnet/gen/grafonnet-v11.4.0@main +``` + +## Usage + +```jsonnet +local grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet" +``` + + +## Subpackages + +* [accesspolicy](accesspolicy/index.md) +* [alerting](alerting/index.md) +* [dashboard](dashboard/index.md) +* [folder](folder.md) +* [librarypanel](librarypanel/index.md) +* [panel](panel/index.md) +* [preferences](preferences.md) +* [publicdashboard](publicdashboard.md) +* [query](query/index.md) +* [role](role.md) +* [rolebinding](rolebinding.md) +* [team](team.md) +* [util](util.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/index.md new file mode 100644 index 0000000..85aafad --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/index.md @@ -0,0 +1,156 @@ +# accesspolicy + +grafonnet.accesspolicy + +## Subpackages + +* [rules](rules.md) + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withScopeMixin(value)`](#fn-withscopemixin) +* [`obj role`](#obj-role) + * [`fn withKind(value)`](#fn-rolewithkind) + * [`fn withName(value)`](#fn-rolewithname) + * [`fn withXname(value)`](#fn-rolewithxname) +* [`obj scope`](#obj-scope) + * [`fn withKind(value)`](#fn-scopewithkind) + * [`fn withName(value)`](#fn-scopewithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role that must apply this policy +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role that must apply this policy +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The set of rules to apply. Note that * is required to modify +access policy rules, and that "none" will reject all actions +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The scope where these policies should apply +### fn withScopeMixin + +```jsonnet +withScopeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The scope where these policies should apply +### obj role + + +#### fn role.withKind + +```jsonnet +role.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Role"`, `"BuiltinRole"`, `"Team"`, `"User"` + +Policies can apply to roles, teams, or users +Applying policies to individual users is supported, but discouraged +#### fn role.withName + +```jsonnet +role.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn role.withXname + +```jsonnet +role.withXname(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj scope + + +#### fn scope.withKind + +```jsonnet +scope.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn scope.withName + +```jsonnet +scope.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/rules.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/rules.md new file mode 100644 index 0000000..f576339 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/accesspolicy/rules.md @@ -0,0 +1,60 @@ +# rules + + + +## Index + +* [`fn withKind(value="*")`](#fn-withkind) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withVerb(value)`](#fn-withverb) +* [`fn withVerbMixin(value)`](#fn-withverbmixin) + +## Fields + +### fn withKind + +```jsonnet +withKind(value="*") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"*"` + +The kind this rule applies to (dashboards, alert, etc) +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific sub-elements like "alert.rules" or "dashboard.permissions"???? +### fn withVerb + +```jsonnet +withVerb(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" +### fn withVerbMixin + +```jsonnet +withVerbMixin(value) +``` + +PARAMETERS: + +* **value** (`string`) + +READ, WRITE, CREATE, DELETE, ... +should move to k8s style verbs like: "get", "list", "watch", "create", "update", "patch", "delete" \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/contactPoint.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/contactPoint.md new file mode 100644 index 0000000..b796b0c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/contactPoint.md @@ -0,0 +1,100 @@ +# contactPoint + +grafonnet.alerting.contactPoint + +**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. + + +## Index + +* [`fn withDisableResolveMessage(value=true)`](#fn-withdisableresolvemessage) +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withDisableResolveMessage + +```jsonnet +withDisableResolveMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name is used as grouping key in the UI. Contact points with the +same name will be grouped in the UI. +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"alertmanager"`, `" dingding"`, `" discord"`, `" email"`, `" googlechat"`, `" kafka"`, `" line"`, `" opsgenie"`, `" pagerduty"`, `" pushover"`, `" sensugo"`, `" slack"`, `" teams"`, `" telegram"`, `" threema"`, `" victorops"`, `" webhook"`, `" wecom"` + + +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID is the unique identifier of the contact point. The UID can be +set by the user. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/index.md new file mode 100644 index 0000000..3715aa4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/index.md @@ -0,0 +1,11 @@ +# alerting + +grafonnet.alerting + +## Subpackages + +* [contactPoint](contactPoint.md) +* [muteTiming](muteTiming/index.md) +* [notificationPolicy](notificationPolicy/index.md) +* [notificationTemplate](notificationTemplate.md) +* [ruleGroup](ruleGroup/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/index.md new file mode 100644 index 0000000..3aee846 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/index.md @@ -0,0 +1,48 @@ +# muteTiming + +grafonnet.alerting.muteTiming + +## Subpackages + +* [interval](interval/index.md) + +## Index + +* [`fn withIntervals(value)`](#fn-withintervals) +* [`fn withIntervalsMixin(value)`](#fn-withintervalsmixin) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withIntervals + +```jsonnet +withIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withIntervalsMixin + +```jsonnet +withIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/index.md new file mode 100644 index 0000000..18021fc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/index.md @@ -0,0 +1,48 @@ +# interval + + + +## Subpackages + +* [time_intervals](time_intervals/index.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeIntervals(value)`](#fn-withtimeintervals) +* [`fn withTimeIntervalsMixin(value)`](#fn-withtimeintervalsmixin) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeIntervals + +```jsonnet +withTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimeIntervalsMixin + +```jsonnet +withTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/index.md new file mode 100644 index 0000000..e649ec2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/index.md @@ -0,0 +1,144 @@ +# time_intervals + + + +## Subpackages + +* [times](times.md) + +## Index + +* [`fn withDaysOfMonth(value)`](#fn-withdaysofmonth) +* [`fn withDaysOfMonthMixin(value)`](#fn-withdaysofmonthmixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withMonths(value)`](#fn-withmonths) +* [`fn withMonthsMixin(value)`](#fn-withmonthsmixin) +* [`fn withTimes(value)`](#fn-withtimes) +* [`fn withTimesMixin(value)`](#fn-withtimesmixin) +* [`fn withWeekdays(value)`](#fn-withweekdays) +* [`fn withWeekdaysMixin(value)`](#fn-withweekdaysmixin) +* [`fn withYears(value)`](#fn-withyears) +* [`fn withYearsMixin(value)`](#fn-withyearsmixin) + +## Fields + +### fn withDaysOfMonth + +```jsonnet +withDaysOfMonth(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDaysOfMonthMixin + +```jsonnet +withDaysOfMonthMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMonths + +```jsonnet +withMonths(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMonthsMixin + +```jsonnet +withMonthsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimes + +```jsonnet +withTimes(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withTimesMixin + +```jsonnet +withTimesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdays + +```jsonnet +withWeekdays(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withWeekdaysMixin + +```jsonnet +withWeekdaysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYears + +```jsonnet +withYears(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withYearsMixin + +```jsonnet +withYearsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/times.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/times.md new file mode 100644 index 0000000..8304969 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/muteTiming/interval/time_intervals/times.md @@ -0,0 +1,32 @@ +# times + + + +## Index + +* [`fn withEndTime(value)`](#fn-withendtime) +* [`fn withStartTime(value)`](#fn-withstarttime) + +## Fields + +### fn withEndTime + +```jsonnet +withEndTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withStartTime + +```jsonnet +withStartTime(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/index.md new file mode 100644 index 0000000..cb4aa0a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/index.md @@ -0,0 +1,173 @@ +# notificationPolicy + +grafonnet.alerting.notificationPolicy + +## Subpackages + +* [matcher](matcher.md) + +## Index + +* [`fn withContactPoint(value)`](#fn-withcontactpoint) +* [`fn withContinue(value=true)`](#fn-withcontinue) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withGroupInterval(value)`](#fn-withgroupinterval) +* [`fn withGroupWait(value)`](#fn-withgroupwait) +* [`fn withMatchers(value)`](#fn-withmatchers) +* [`fn withMatchersMixin(value)`](#fn-withmatchersmixin) +* [`fn withMuteTimeIntervals(value)`](#fn-withmutetimeintervals) +* [`fn withMuteTimeIntervalsMixin(value)`](#fn-withmutetimeintervalsmixin) +* [`fn withPolicy(value)`](#fn-withpolicy) +* [`fn withPolicyMixin(value)`](#fn-withpolicymixin) +* [`fn withRepeatInterval(value)`](#fn-withrepeatinterval) + +## Fields + +### fn withContactPoint + +```jsonnet +withContactPoint(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withContinue + +```jsonnet +withContinue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupInterval + +```jsonnet +withGroupInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withGroupWait + +```jsonnet +withGroupWait(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withMatchers + +```jsonnet +withMatchers(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMatchersMixin + +```jsonnet +withMatchersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Matchers is a slice of Matchers that is sortable, implements Stringer, and +provides a Matches method to match a LabelSet against all Matchers in the +slice. Note that some users of Matchers might require it to be sorted. +### fn withMuteTimeIntervals + +```jsonnet +withMuteTimeIntervals(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withMuteTimeIntervalsMixin + +```jsonnet +withMuteTimeIntervalsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicy + +```jsonnet +withPolicy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPolicyMixin + +```jsonnet +withPolicyMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeatInterval + +```jsonnet +withRepeatInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/matcher.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/matcher.md new file mode 100644 index 0000000..7cad0a7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationPolicy/matcher.md @@ -0,0 +1,45 @@ +# matcher + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType(value)`](#fn-withtype) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"="`, `"!="`, `"=~"`, `"!~"` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationTemplate.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationTemplate.md new file mode 100644 index 0000000..aeb1df1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/notificationTemplate.md @@ -0,0 +1,56 @@ +# notificationTemplate + +grafonnet.alerting.notificationTemplate + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withProvenance(value)`](#fn-withprovenance) +* [`fn withTemplate(value)`](#fn-withtemplate) +* [`fn withVersion(value)`](#fn-withversion) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withProvenance + +```jsonnet +withProvenance(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTemplate + +```jsonnet +withTemplate(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withVersion + +```jsonnet +withVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/index.md new file mode 100644 index 0000000..588ead0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/index.md @@ -0,0 +1,72 @@ +# ruleGroup + +grafonnet.alerting.ruleGroup + +## Subpackages + +* [rule](rule/index.md) + +## Index + +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withName(value)`](#fn-withname) +* [`fn withRules(value)`](#fn-withrules) +* [`fn withRulesMixin(value)`](#fn-withrulesmixin) + +## Fields + +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRules + +```jsonnet +withRules(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRulesMixin + +```jsonnet +withRulesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/data.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/data.md new file mode 100644 index 0000000..adeccf0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/data.md @@ -0,0 +1,124 @@ +# data + + + +## Index + +* [`fn withDatasourceUid(value)`](#fn-withdatasourceuid) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRelativeTimeRange(value)`](#fn-withrelativetimerange) +* [`fn withRelativeTimeRangeMixin(value)`](#fn-withrelativetimerangemixin) +* [`obj relativeTimeRange`](#obj-relativetimerange) + * [`fn withFrom(value)`](#fn-relativetimerangewithfrom) + * [`fn withTo(value)`](#fn-relativetimerangewithto) + +## Fields + +### fn withDatasourceUid + +```jsonnet +withDatasourceUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation. +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +JSON is the raw JSON query and includes the above properties as well as custom properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withRelativeTimeRange + +```jsonnet +withRelativeTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### fn withRelativeTimeRangeMixin + +```jsonnet +withRelativeTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +RelativeTimeRange is the per query start and end time +for requests. +### obj relativeTimeRange + + +#### fn relativeTimeRange.withFrom + +```jsonnet +relativeTimeRange.withFrom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. +#### fn relativeTimeRange.withTo + +```jsonnet +relativeTimeRange.withTo(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Duration in seconds. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/index.md new file mode 100644 index 0000000..27748f0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/alerting/ruleGroup/rule/index.md @@ -0,0 +1,196 @@ +# rule + + + +## Subpackages + +* [data](data.md) + +## Index + +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withCondition(value)`](#fn-withcondition) +* [`fn withData(value)`](#fn-withdata) +* [`fn withDataMixin(value)`](#fn-withdatamixin) +* [`fn withExecErrState(value)`](#fn-withexecerrstate) +* [`fn withFolderUID(value)`](#fn-withfolderuid) +* [`fn withFor(value)`](#fn-withfor) +* [`fn withIsPaused(value=true)`](#fn-withispaused) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLabelsMixin(value)`](#fn-withlabelsmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withNoDataState(value)`](#fn-withnodatastate) +* [`fn withOrgID(value)`](#fn-withorgid) +* [`fn withRuleGroup(value)`](#fn-withrulegroup) + +## Fields + +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withCondition + +```jsonnet +withCondition(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withData + +```jsonnet +withData(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDataMixin + +```jsonnet +withDataMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withExecErrState + +```jsonnet +withExecErrState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"OK"`, `"Alerting"`, `"Error"` + + +### fn withFolderUID + +```jsonnet +withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withFor + +```jsonnet +withFor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The amount of time, in seconds, for which the rule must be breached for the rule to be considered to be Firing. +Before this time has elapsed, the rule is only considered to be Pending. +### fn withIsPaused + +```jsonnet +withIsPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelsMixin + +```jsonnet +withLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withNoDataState + +```jsonnet +withNoDataState(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Alerting"`, `"NoData"`, `"OK"` + + +### fn withOrgID + +```jsonnet +withOrgID(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withRuleGroup + +```jsonnet +withRuleGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/annotation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/annotation.md new file mode 100644 index 0000000..5a7645c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/annotation.md @@ -0,0 +1,310 @@ +# annotation + + + +## Index + +* [`fn withBuiltIn(value=0)`](#fn-withbuiltin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEnable(value=true)`](#fn-withenable) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIconColor(value)`](#fn-withiconcolor) +* [`fn withName(value)`](#fn-withname) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj filter`](#obj-filter) + * [`fn withExclude(value=true)`](#fn-filterwithexclude) + * [`fn withIds(value)`](#fn-filterwithids) + * [`fn withIdsMixin(value)`](#fn-filterwithidsmixin) +* [`obj target`](#obj-target) + * [`fn withLimit(value)`](#fn-targetwithlimit) + * [`fn withMatchAny(value=true)`](#fn-targetwithmatchany) + * [`fn withTags(value)`](#fn-targetwithtags) + * [`fn withTagsMixin(value)`](#fn-targetwithtagsmixin) + * [`fn withType(value)`](#fn-targetwithtype) + +## Fields + +### fn withBuiltIn + +```jsonnet +withBuiltIn(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Set to 1 for the standard annotation query all dashboards have by default. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEnable + +```jsonnet +withEnable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled the annotation query is issued with every dashboard refresh +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Filters to apply when fetching annotations +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Filters to apply when fetching annotations +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Annotation queries can be toggled on or off at the top of the dashboard. +When hide is true, the toggle is not shown in the dashboard. +### fn withIconColor + +```jsonnet +withIconColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color to use for the annotation event markers +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of annotation. +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: this should be a regular DataQuery that depends on the selected dashboard +these match the properties of the "grafana" datasouce that is default in most dashboards +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TODO -- this should not exist here, it is based on the --grafana-- datasource +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj filter + + +#### fn filter.withExclude + +```jsonnet +filter.withExclude(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Should the specified panels be included or excluded +#### fn filter.withIds + +```jsonnet +filter.withIds(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +#### fn filter.withIdsMixin + +```jsonnet +filter.withIdsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel IDs that should be included or excluded +### obj target + + +#### fn target.withLimit + +```jsonnet +target.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withMatchAny + +```jsonnet +target.withMatchAny(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTags + +```jsonnet +target.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withTagsMixin + +```jsonnet +target.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change +#### fn target.withType + +```jsonnet +target.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only required/valid for the grafana datasource... +but code+tests is already depending on it so hard to change \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/index.md new file mode 100644 index 0000000..ec78d46 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/index.md @@ -0,0 +1,479 @@ +# dashboard + +grafonnet.dashboard + +## Subpackages + +* [annotation](annotation.md) +* [link](link.md) +* [variable](variable.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withAnnotations(value)`](#fn-withannotations) +* [`fn withAnnotationsMixin(value)`](#fn-withannotationsmixin) +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withEditable(value=true)`](#fn-witheditable) +* [`fn withFiscalYearStartMonth(value=0)`](#fn-withfiscalyearstartmonth) +* [`fn withLinks(value)`](#fn-withlinks) +* [`fn withLinksMixin(value)`](#fn-withlinksmixin) +* [`fn withLiveNow(value=true)`](#fn-withlivenow) +* [`fn withPanels(panels, setPanelIDs=true)`](#fn-withpanels) +* [`fn withPanelsMixin(panels, setPanelIDs=true)`](#fn-withpanelsmixin) +* [`fn withRefresh(value)`](#fn-withrefresh) +* [`fn withSchemaVersion(value=39)`](#fn-withschemaversion) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTemplating(value)`](#fn-withtemplating) +* [`fn withTemplatingMixin(value)`](#fn-withtemplatingmixin) +* [`fn withTimezone(value="browser")`](#fn-withtimezone) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVariables(value)`](#fn-withvariables) +* [`fn withVariablesMixin(value)`](#fn-withvariablesmixin) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj graphTooltip`](#obj-graphtooltip) + * [`fn withSharedCrosshair()`](#fn-graphtooltipwithsharedcrosshair) + * [`fn withSharedTooltip()`](#fn-graphtooltipwithsharedtooltip) +* [`obj time`](#obj-time) + * [`fn withFrom(value="now-6h")`](#fn-timewithfrom) + * [`fn withTo(value="now")`](#fn-timewithto) +* [`obj timepicker`](#obj-timepicker) + * [`fn withHidden(value=true)`](#fn-timepickerwithhidden) + * [`fn withNowDelay(value)`](#fn-timepickerwithnowdelay) + * [`fn withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervals) + * [`fn withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"])`](#fn-timepickerwithrefreshintervalsmixin) + * [`fn withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptions) + * [`fn withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"])`](#fn-timepickerwithtimeoptionsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboard with a title. +### fn withAnnotations + +```jsonnet +withAnnotations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotations` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withAnnotationsMixin + +```jsonnet +withAnnotationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withAnnotationsMixin` adds an array of annotations to a dashboard. + +This function appends passed data to existing values + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of dashboard. +### fn withEditable + +```jsonnet +withEditable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether a dashboard is editable or not. +### fn withFiscalYearStartMonth + +```jsonnet +withFiscalYearStartMonth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +The month that the fiscal year starts on. 0 = January, 11 = December +### fn withLinks + +```jsonnet +withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLinksMixin + +```jsonnet +withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +`withLinks` takes an array of [link objects](./link.md). + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + +### fn withLiveNow + +```jsonnet +withLiveNow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When set to true, the dashboard will redraw panels at an interval matching the pixel width. +This will keep data "moving left" regardless of the query refresh rate. This setting helps +avoid dashboards presenting stale live data +### fn withPanels + +```jsonnet +withPanels(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanels` sets the panels on a dashboard authoratively. It automatically adds IDs to the panels, this can be disabled with `setPanelIDs=false`. +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(panels, setPanelIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **setPanelIDs** (`bool`) + - default value: `true` + +`withPanelsMixin` adds more panels to a dashboard. +### fn withRefresh + +```jsonnet +withRefresh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Refresh rate of dashboard. Represented via interval string, e.g. "5s", "1m", "1h", "1d". +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value=39) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `39` + + +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Tags associated with dashboard. +### fn withTemplating + +```jsonnet +withTemplating(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTemplatingMixin + +```jsonnet +withTemplatingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configured template variables +### fn withTimezone + +```jsonnet +withTimezone(value="browser") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"browser"` + +Timezone of dashboard. Accepted values are IANA TZDB zone ID or "browser" or "utc". +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title of dashboard. +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique dashboard identifier that can be generated by anyone. string (8-40) +### fn withVariables + +```jsonnet +withVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariables` adds an array of variables to a dashboard + +### fn withVariablesMixin + +```jsonnet +withVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +`withVariablesMixin` adds an array of variables to a dashboard. + +This function appends passed data to existing values + +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Day when the week starts. Expressed by the name of the day in lowercase, e.g. "monday". +### obj graphTooltip + + +#### fn graphTooltip.withSharedCrosshair + +```jsonnet +graphTooltip.withSharedCrosshair() +``` + + +Share crosshair on all panels. +#### fn graphTooltip.withSharedTooltip + +```jsonnet +graphTooltip.withSharedTooltip() +``` + + +Share crosshair and tooltip on all panels. +### obj time + + +#### fn time.withFrom + +```jsonnet +time.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + + +#### fn time.withTo + +```jsonnet +time.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + + +### obj timepicker + + +#### fn timepicker.withHidden + +```jsonnet +timepicker.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether timepicker is visible or not. +#### fn timepicker.withNowDelay + +```jsonnet +timepicker.withNowDelay(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Override the now time by entering a time delay. Use this option to accommodate known delays in data aggregation to avoid null values. +#### fn timepicker.withRefreshIntervals + +```jsonnet +timepicker.withRefreshIntervals(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withRefreshIntervalsMixin + +```jsonnet +timepicker.withRefreshIntervalsMixin(value=["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"]` + +Interval options available in the refresh picker dropdown. +#### fn timepicker.withTimeOptions + +```jsonnet +timepicker.withTimeOptions(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. +#### fn timepicker.withTimeOptionsMixin + +```jsonnet +timepicker.withTimeOptionsMixin(value=["5m","15m","1h","6h","12h","24h","2d","7d","30d"]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `["5m","15m","1h","6h","12h","24h","2d","7d","30d"]` + +Selectable options available in the time picker dropdown. Has no effect on provisioned dashboard. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/link.md new file mode 100644 index 0000000..421e0c0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/link.md @@ -0,0 +1,196 @@ +# link + +Dashboard links are displayed at the top of the dashboard, these can either link to other dashboards or to external URLs. + +The [docs](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links) give a more comprehensive description. + +Example: + +```jsonnet +local g = import 'g.libsonnet'; +local link = g.dashboard.link; + +g.dashboard.new('Title dashboard') ++ g.dashboard.withLinks([ + link.link.new('My title', 'https://wikipedia.org/'), +]) +``` + + +## Index + +* [`obj dashboards`](#obj-dashboards) + * [`fn new(title, tags)`](#fn-dashboardsnew) + * [`obj options`](#obj-dashboardsoptions) + * [`fn withAsDropdown(value=true)`](#fn-dashboardsoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-dashboardsoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-dashboardsoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-dashboardsoptionswithtargetblank) +* [`obj link`](#obj-link) + * [`fn new(title, url)`](#fn-linknew) + * [`fn withIcon(value)`](#fn-linkwithicon) + * [`fn withTooltip(value)`](#fn-linkwithtooltip) + * [`obj options`](#obj-linkoptions) + * [`fn withAsDropdown(value=true)`](#fn-linkoptionswithasdropdown) + * [`fn withIncludeVars(value=true)`](#fn-linkoptionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-linkoptionswithkeeptime) + * [`fn withTargetBlank(value=true)`](#fn-linkoptionswithtargetblank) + +## Fields + +### obj dashboards + + +#### fn dashboards.new + +```jsonnet +dashboards.new(title, tags) +``` + +PARAMETERS: + +* **title** (`string`) +* **tags** (`array`) + +Create links to dashboards based on `tags`. + +#### obj dashboards.options + + +##### fn dashboards.options.withAsDropdown + +```jsonnet +dashboards.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +##### fn dashboards.options.withIncludeVars + +```jsonnet +dashboards.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn dashboards.options.withKeepTime + +```jsonnet +dashboards.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn dashboards.options.withTargetBlank + +```jsonnet +dashboards.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### obj link + + +#### fn link.new + +```jsonnet +link.new(title, url) +``` + +PARAMETERS: + +* **title** (`string`) +* **url** (`string`) + +Create link to an arbitrary URL. + +#### fn link.withIcon + +```jsonnet +link.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +#### fn link.withTooltip + +```jsonnet +link.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +#### obj link.options + + +##### fn link.options.withAsDropdown + +```jsonnet +link.options.withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +##### fn link.options.withIncludeVars + +```jsonnet +link.options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +##### fn link.options.withKeepTime + +```jsonnet +link.options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +##### fn link.options.withTargetBlank + +```jsonnet +link.options.withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/variable.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/variable.md new file mode 100644 index 0000000..e5114ea --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/dashboard/variable.md @@ -0,0 +1,1054 @@ +# variable + +Example usage: + +```jsonnet +local g = import 'g.libsonnet'; +local var = g.dashboard.variable; + +local customVar = + var.custom.new( + 'myOptions', + values=['a', 'b', 'c', 'd'], + ) + + var.custom.generalOptions.withDescription( + 'This is a variable for my custom options.' + ) + + var.custom.selectionOptions.withMulti(); + +local queryVar = + var.query.new('queryOptions') + + var.query.queryTypes.withLabelValues( + 'up', + 'instance', + ) + + var.query.withDatasource( + type='prometheus', + uid='mimir-prod', + ) + + var.query.selectionOptions.withIncludeAll(); + + +g.dashboard.new('my dashboard') ++ g.dashboard.withVariables([ + customVar, + queryVar, +]) +``` + + +## Index + +* [`obj adhoc`](#obj-adhoc) + * [`fn new(name, type, uid)`](#fn-adhocnew) + * [`fn newFromDatasourceVariable(name, variable)`](#fn-adhocnewfromdatasourcevariable) + * [`obj generalOptions`](#obj-adhocgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-adhocgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-adhocgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-adhocgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-adhocgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-adhocgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-adhocgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-adhocgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-adhocgeneraloptionsshowondashboardwithvalueonly) +* [`obj constant`](#obj-constant) + * [`fn new(name, value)`](#fn-constantnew) + * [`obj generalOptions`](#obj-constantgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-constantgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-constantgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-constantgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-constantgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-constantgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-constantgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-constantgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-constantgeneraloptionsshowondashboardwithvalueonly) +* [`obj custom`](#obj-custom) + * [`fn new(name, values)`](#fn-customnew) + * [`obj generalOptions`](#obj-customgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-customgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-customgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-customgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-customgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-customgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-customgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-customgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-customgeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-customselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-customselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-customselectionoptionswithmulti) +* [`obj datasource`](#obj-datasource) + * [`fn new(name, type)`](#fn-datasourcenew) + * [`fn withRegex(value)`](#fn-datasourcewithregex) + * [`obj generalOptions`](#obj-datasourcegeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-datasourcegeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-datasourcegeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-datasourcegeneraloptionswithlabel) + * [`fn withName(value)`](#fn-datasourcegeneraloptionswithname) + * [`obj showOnDashboard`](#obj-datasourcegeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-datasourcegeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-datasourcegeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-datasourcegeneraloptionsshowondashboardwithvalueonly) + * [`obj selectionOptions`](#obj-datasourceselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-datasourceselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-datasourceselectionoptionswithmulti) +* [`obj interval`](#obj-interval) + * [`fn new(name, values)`](#fn-intervalnew) + * [`fn withAutoOption(count, minInterval)`](#fn-intervalwithautooption) + * [`obj generalOptions`](#obj-intervalgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-intervalgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-intervalgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-intervalgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-intervalgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-intervalgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-intervalgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-intervalgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-intervalgeneraloptionsshowondashboardwithvalueonly) +* [`obj query`](#obj-query) + * [`fn new(name, query="")`](#fn-querynew) + * [`fn withDatasource(type, uid)`](#fn-querywithdatasource) + * [`fn withDatasourceFromVariable(variable)`](#fn-querywithdatasourcefromvariable) + * [`fn withRegex(value)`](#fn-querywithregex) + * [`fn withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false)`](#fn-querywithsort) + * [`obj generalOptions`](#obj-querygeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-querygeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-querygeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-querygeneraloptionswithlabel) + * [`fn withName(value)`](#fn-querygeneraloptionswithname) + * [`obj showOnDashboard`](#obj-querygeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-querygeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-querygeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-querygeneraloptionsshowondashboardwithvalueonly) + * [`obj queryTypes`](#obj-queryquerytypes) + * [`fn withLabelValues(label, metric="")`](#fn-queryquerytypeswithlabelvalues) + * [`fn withQueryResult(query)`](#fn-queryquerytypeswithqueryresult) + * [`obj refresh`](#obj-queryrefresh) + * [`fn onLoad()`](#fn-queryrefreshonload) + * [`fn onTime()`](#fn-queryrefreshontime) + * [`obj selectionOptions`](#obj-queryselectionoptions) + * [`fn withIncludeAll(value=true, customAllValue)`](#fn-queryselectionoptionswithincludeall) + * [`fn withMulti(value=true)`](#fn-queryselectionoptionswithmulti) +* [`obj textbox`](#obj-textbox) + * [`fn new(name, default="")`](#fn-textboxnew) + * [`obj generalOptions`](#obj-textboxgeneraloptions) + * [`fn withCurrent(key, value="")`](#fn-textboxgeneraloptionswithcurrent) + * [`fn withDescription(value)`](#fn-textboxgeneraloptionswithdescription) + * [`fn withLabel(value)`](#fn-textboxgeneraloptionswithlabel) + * [`fn withName(value)`](#fn-textboxgeneraloptionswithname) + * [`obj showOnDashboard`](#obj-textboxgeneraloptionsshowondashboard) + * [`fn withLabelAndValue()`](#fn-textboxgeneraloptionsshowondashboardwithlabelandvalue) + * [`fn withNothing()`](#fn-textboxgeneraloptionsshowondashboardwithnothing) + * [`fn withValueOnly()`](#fn-textboxgeneraloptionsshowondashboardwithvalueonly) + +## Fields + +### obj adhoc + + +#### fn adhoc.new + +```jsonnet +adhoc.new(name, type, uid) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **uid** (`string`) + +`new` creates an adhoc template variable for datasource with `type` and `uid`. +#### fn adhoc.newFromDatasourceVariable + +```jsonnet +adhoc.newFromDatasourceVariable(name, variable) +``` + +PARAMETERS: + +* **name** (`string`) +* **variable** (`object`) + +Same as `new` but selecting the datasource from another template variable. +#### obj adhoc.generalOptions + + +##### fn adhoc.generalOptions.withCurrent + +```jsonnet +adhoc.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn adhoc.generalOptions.withDescription + +```jsonnet +adhoc.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn adhoc.generalOptions.withLabel + +```jsonnet +adhoc.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn adhoc.generalOptions.withName + +```jsonnet +adhoc.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj adhoc.generalOptions.showOnDashboard + + +###### fn adhoc.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +adhoc.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withNothing + +```jsonnet +adhoc.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn adhoc.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +adhoc.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj constant + + +#### fn constant.new + +```jsonnet +constant.new(name, value) +``` + +PARAMETERS: + +* **name** (`string`) +* **value** (`string`) + +`new` creates a hidden constant template variable. +#### obj constant.generalOptions + + +##### fn constant.generalOptions.withCurrent + +```jsonnet +constant.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn constant.generalOptions.withDescription + +```jsonnet +constant.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn constant.generalOptions.withLabel + +```jsonnet +constant.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn constant.generalOptions.withName + +```jsonnet +constant.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj constant.generalOptions.showOnDashboard + + +###### fn constant.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +constant.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withNothing + +```jsonnet +constant.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn constant.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +constant.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj custom + + +#### fn custom.new + +```jsonnet +custom.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates a custom template variable. + +The `values` array accepts an object with key/value keys, if it's not an object +then it will be added as a string. + +Example: +``` +[ + { key: 'mykey', value: 'myvalue' }, + 'myvalue', + 12, +] + +#### obj custom.generalOptions + + +##### fn custom.generalOptions.withCurrent + +```jsonnet +custom.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn custom.generalOptions.withDescription + +```jsonnet +custom.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn custom.generalOptions.withLabel + +```jsonnet +custom.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn custom.generalOptions.withName + +```jsonnet +custom.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj custom.generalOptions.showOnDashboard + + +###### fn custom.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +custom.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withNothing + +```jsonnet +custom.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn custom.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +custom.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj custom.selectionOptions + + +##### fn custom.selectionOptions.withIncludeAll + +```jsonnet +custom.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn custom.selectionOptions.withMulti + +```jsonnet +custom.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj datasource + + +#### fn datasource.new + +```jsonnet +datasource.new(name, type) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) + +`new` creates a datasource template variable. +#### fn datasource.withRegex + +```jsonnet +datasource.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` filter for which data source instances to choose from in the +variable value list. Example: `/^prod/` + +#### obj datasource.generalOptions + + +##### fn datasource.generalOptions.withCurrent + +```jsonnet +datasource.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn datasource.generalOptions.withDescription + +```jsonnet +datasource.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn datasource.generalOptions.withLabel + +```jsonnet +datasource.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn datasource.generalOptions.withName + +```jsonnet +datasource.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj datasource.generalOptions.showOnDashboard + + +###### fn datasource.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +datasource.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withNothing + +```jsonnet +datasource.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn datasource.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +datasource.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj datasource.selectionOptions + + +##### fn datasource.selectionOptions.withIncludeAll + +```jsonnet +datasource.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn datasource.selectionOptions.withMulti + +```jsonnet +datasource.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj interval + + +#### fn interval.new + +```jsonnet +interval.new(name, values) +``` + +PARAMETERS: + +* **name** (`string`) +* **values** (`array`) + +`new` creates an interval template variable. +#### fn interval.withAutoOption + +```jsonnet +interval.withAutoOption(count, minInterval) +``` + +PARAMETERS: + +* **count** (`number`) +* **minInterval** (`string`) + +`withAutoOption` adds an options to dynamically calculate interval by dividing +time range by the count specified. + +`minInterval' has to be either unit-less or end with one of the following units: +"y, M, w, d, h, m, s, ms". + +#### obj interval.generalOptions + + +##### fn interval.generalOptions.withCurrent + +```jsonnet +interval.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn interval.generalOptions.withDescription + +```jsonnet +interval.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn interval.generalOptions.withLabel + +```jsonnet +interval.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn interval.generalOptions.withName + +```jsonnet +interval.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj interval.generalOptions.showOnDashboard + + +###### fn interval.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +interval.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withNothing + +```jsonnet +interval.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn interval.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +interval.generalOptions.showOnDashboard.withValueOnly() +``` + + + +### obj query + + +#### fn query.new + +```jsonnet +query.new(name, query="") +``` + +PARAMETERS: + +* **name** (`string`) +* **query** (`string`) + - default value: `""` + +Create a query template variable. + +`query` argument is optional, this can also be set with `query.queryTypes`. + +#### fn query.withDatasource + +```jsonnet +query.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +Select a datasource for the variable template query. +#### fn query.withDatasourceFromVariable + +```jsonnet +query.withDatasourceFromVariable(variable) +``` + +PARAMETERS: + +* **variable** (`object`) + +Select the datasource from another template variable. +#### fn query.withRegex + +```jsonnet +query.withRegex(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`withRegex` can extract part of a series name or metric node segment. Named +capture groups can be used to separate the display text and value +([see examples](https://grafana.com/docs/grafana/latest/variables/filter-variables-with-regex#filter-and-modify-using-named-text-and-value-capture-groups)). + +#### fn query.withSort + +```jsonnet +query.withSort(i=0, type="alphabetical", asc=true, caseInsensitive=false) +``` + +PARAMETERS: + +* **i** (`number`) + - default value: `0` +* **type** (`string`) + - default value: `"alphabetical"` +* **asc** (`bool`) + - default value: `true` +* **caseInsensitive** (`bool`) + - default value: `false` + +Choose how to sort the values in the dropdown. + +This can be called as `withSort() to use the integer values for each +option. If `i==0` then it will be ignored and the other arguments will take +precedence. + +The numerical values are: + +- 1 - Alphabetical (asc) +- 2 - Alphabetical (desc) +- 3 - Numerical (asc) +- 4 - Numerical (desc) +- 5 - Alphabetical (case-insensitive, asc) +- 6 - Alphabetical (case-insensitive, desc) + +#### obj query.generalOptions + + +##### fn query.generalOptions.withCurrent + +```jsonnet +query.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn query.generalOptions.withDescription + +```jsonnet +query.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn query.generalOptions.withLabel + +```jsonnet +query.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn query.generalOptions.withName + +```jsonnet +query.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj query.generalOptions.showOnDashboard + + +###### fn query.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +query.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn query.generalOptions.showOnDashboard.withNothing + +```jsonnet +query.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn query.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +query.generalOptions.showOnDashboard.withValueOnly() +``` + + + +#### obj query.queryTypes + + +##### fn query.queryTypes.withLabelValues + +```jsonnet +query.queryTypes.withLabelValues(label, metric="") +``` + +PARAMETERS: + +* **label** (`string`) +* **metric** (`string`) + - default value: `""` + +Construct a Prometheus template variable using `label_values()`. +##### fn query.queryTypes.withQueryResult + +```jsonnet +query.queryTypes.withQueryResult(query) +``` + +PARAMETERS: + +* **query** (`string`) + +Construct a Prometheus template variable using `query_result()`. +#### obj query.refresh + + +##### fn query.refresh.onLoad + +```jsonnet +query.refresh.onLoad() +``` + + +Refresh label values on dashboard load. +##### fn query.refresh.onTime + +```jsonnet +query.refresh.onTime() +``` + + +Refresh label values on time range change. +#### obj query.selectionOptions + + +##### fn query.selectionOptions.withIncludeAll + +```jsonnet +query.selectionOptions.withIncludeAll(value=true, customAllValue) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` +* **customAllValue** (`string`) + +`withIncludeAll` enables an option to include all variables. + +Optionally you can set a `customAllValue`. + +##### fn query.selectionOptions.withMulti + +```jsonnet +query.selectionOptions.withMulti(value=true) +``` + +PARAMETERS: + +* **value** (`bool`) + - default value: `true` + +Enable selecting multiple values. +### obj textbox + + +#### fn textbox.new + +```jsonnet +textbox.new(name, default="") +``` + +PARAMETERS: + +* **name** (`string`) +* **default** (`string`) + - default value: `""` + +`new` creates a textbox template variable. +#### obj textbox.generalOptions + + +##### fn textbox.generalOptions.withCurrent + +```jsonnet +textbox.generalOptions.withCurrent(key, value="") +``` + +PARAMETERS: + +* **key** (`any`) +* **value** (`any`) + - default value: `""` + +`withCurrent` sets the currently selected value of a variable. If key and value are different, both need to be given. + +##### fn textbox.generalOptions.withDescription + +```jsonnet +textbox.generalOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Description of variable. It can be defined but `null`. +##### fn textbox.generalOptions.withLabel + +```jsonnet +textbox.generalOptions.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display name +##### fn textbox.generalOptions.withName + +```jsonnet +textbox.generalOptions.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of variable +##### obj textbox.generalOptions.showOnDashboard + + +###### fn textbox.generalOptions.showOnDashboard.withLabelAndValue + +```jsonnet +textbox.generalOptions.showOnDashboard.withLabelAndValue() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withNothing + +```jsonnet +textbox.generalOptions.showOnDashboard.withNothing() +``` + + + +###### fn textbox.generalOptions.showOnDashboard.withValueOnly + +```jsonnet +textbox.generalOptions.showOnDashboard.withValueOnly() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/folder.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/folder.md new file mode 100644 index 0000000..ffab037 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/folder.md @@ -0,0 +1,45 @@ +# folder + +grafonnet.folder + +## Index + +* [`fn withParentUid(value)`](#fn-withparentuid) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withParentUid + +```jsonnet +withParentUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +only used if nested folders are enabled +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder title +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique folder id \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/index.md new file mode 100644 index 0000000..bfff6b4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/index.md @@ -0,0 +1,1598 @@ +# librarypanel + +grafonnet.librarypanel + +## Subpackages + +* [model.fieldConfig.defaults.links](model/fieldConfig/defaults/links.md) +* [model.fieldConfig.defaults.thresholds.steps](model/fieldConfig/defaults/thresholds/steps.md) +* [model.fieldConfig.overrides](model/fieldConfig/overrides/index.md) +* [model.links](model/links.md) +* [model.transformations](model/transformations.md) + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withFolderUid(value)`](#fn-withfolderuid) +* [`fn withMeta(value)`](#fn-withmeta) +* [`fn withMetaMixin(value)`](#fn-withmetamixin) +* [`fn withModel(value)`](#fn-withmodel) +* [`fn withModelMixin(value)`](#fn-withmodelmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withSchemaVersion(value)`](#fn-withschemaversion) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUid(value)`](#fn-withuid) +* [`fn withVersion(value)`](#fn-withversion) +* [`obj meta`](#obj-meta) + * [`fn withConnectedDashboards(value)`](#fn-metawithconnecteddashboards) + * [`fn withCreated(value)`](#fn-metawithcreated) + * [`fn withCreatedBy(value)`](#fn-metawithcreatedby) + * [`fn withCreatedByMixin(value)`](#fn-metawithcreatedbymixin) + * [`fn withFolderName(value)`](#fn-metawithfoldername) + * [`fn withFolderUid(value)`](#fn-metawithfolderuid) + * [`fn withUpdated(value)`](#fn-metawithupdated) + * [`fn withUpdatedBy(value)`](#fn-metawithupdatedby) + * [`fn withUpdatedByMixin(value)`](#fn-metawithupdatedbymixin) + * [`obj createdBy`](#obj-metacreatedby) + * [`fn withAvatarUrl(value)`](#fn-metacreatedbywithavatarurl) + * [`fn withId(value)`](#fn-metacreatedbywithid) + * [`fn withName(value)`](#fn-metacreatedbywithname) + * [`obj updatedBy`](#obj-metaupdatedby) + * [`fn withAvatarUrl(value)`](#fn-metaupdatedbywithavatarurl) + * [`fn withId(value)`](#fn-metaupdatedbywithid) + * [`fn withName(value)`](#fn-metaupdatedbywithname) +* [`obj model`](#obj-model) + * [`fn withCacheTimeout(value)`](#fn-modelwithcachetimeout) + * [`fn withDatasource(value)`](#fn-modelwithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-modelwithdatasourcemixin) + * [`fn withDescription(value)`](#fn-modelwithdescription) + * [`fn withFieldConfig(value)`](#fn-modelwithfieldconfig) + * [`fn withFieldConfigMixin(value)`](#fn-modelwithfieldconfigmixin) + * [`fn withHideTimeOverride(value=true)`](#fn-modelwithhidetimeoverride) + * [`fn withInterval(value)`](#fn-modelwithinterval) + * [`fn withLinks(value)`](#fn-modelwithlinks) + * [`fn withLinksMixin(value)`](#fn-modelwithlinksmixin) + * [`fn withMaxDataPoints(value)`](#fn-modelwithmaxdatapoints) + * [`fn withMaxPerRow(value)`](#fn-modelwithmaxperrow) + * [`fn withOptions(value)`](#fn-modelwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelwithoptionsmixin) + * [`fn withPluginVersion(value)`](#fn-modelwithpluginversion) + * [`fn withQueryCachingTTL(value)`](#fn-modelwithquerycachingttl) + * [`fn withRepeat(value)`](#fn-modelwithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-modelwithrepeatdirection) + * [`fn withTargets(value)`](#fn-modelwithtargets) + * [`fn withTargetsMixin(value)`](#fn-modelwithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-modelwithtimefrom) + * [`fn withTimeShift(value)`](#fn-modelwithtimeshift) + * [`fn withTitle(value)`](#fn-modelwithtitle) + * [`fn withTransformations(value)`](#fn-modelwithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-modelwithtransformationsmixin) + * [`fn withTransparent(value=true)`](#fn-modelwithtransparent) + * [`fn withType(value)`](#fn-modelwithtype) + * [`obj datasource`](#obj-modeldatasource) + * [`fn withType(value)`](#fn-modeldatasourcewithtype) + * [`fn withUid(value)`](#fn-modeldatasourcewithuid) + * [`obj fieldConfig`](#obj-modelfieldconfig) + * [`fn withDefaults(value)`](#fn-modelfieldconfigwithdefaults) + * [`fn withDefaultsMixin(value)`](#fn-modelfieldconfigwithdefaultsmixin) + * [`fn withOverrides(value)`](#fn-modelfieldconfigwithoverrides) + * [`fn withOverridesMixin(value)`](#fn-modelfieldconfigwithoverridesmixin) + * [`obj defaults`](#obj-modelfieldconfigdefaults) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultswithcolor) + * [`fn withColorMixin(value)`](#fn-modelfieldconfigdefaultswithcolormixin) + * [`fn withCustom(value)`](#fn-modelfieldconfigdefaultswithcustom) + * [`fn withCustomMixin(value)`](#fn-modelfieldconfigdefaultswithcustommixin) + * [`fn withDecimals(value)`](#fn-modelfieldconfigdefaultswithdecimals) + * [`fn withDescription(value)`](#fn-modelfieldconfigdefaultswithdescription) + * [`fn withDisplayName(value)`](#fn-modelfieldconfigdefaultswithdisplayname) + * [`fn withDisplayNameFromDS(value)`](#fn-modelfieldconfigdefaultswithdisplaynamefromds) + * [`fn withFilterable(value=true)`](#fn-modelfieldconfigdefaultswithfilterable) + * [`fn withLinks(value)`](#fn-modelfieldconfigdefaultswithlinks) + * [`fn withLinksMixin(value)`](#fn-modelfieldconfigdefaultswithlinksmixin) + * [`fn withMappings(value)`](#fn-modelfieldconfigdefaultswithmappings) + * [`fn withMappingsMixin(value)`](#fn-modelfieldconfigdefaultswithmappingsmixin) + * [`fn withMax(value)`](#fn-modelfieldconfigdefaultswithmax) + * [`fn withMin(value)`](#fn-modelfieldconfigdefaultswithmin) + * [`fn withNoValue(value)`](#fn-modelfieldconfigdefaultswithnovalue) + * [`fn withPath(value)`](#fn-modelfieldconfigdefaultswithpath) + * [`fn withThresholds(value)`](#fn-modelfieldconfigdefaultswiththresholds) + * [`fn withThresholdsMixin(value)`](#fn-modelfieldconfigdefaultswiththresholdsmixin) + * [`fn withUnit(value)`](#fn-modelfieldconfigdefaultswithunit) + * [`fn withWriteable(value=true)`](#fn-modelfieldconfigdefaultswithwriteable) + * [`obj color`](#obj-modelfieldconfigdefaultscolor) + * [`fn withFixedColor(value)`](#fn-modelfieldconfigdefaultscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-modelfieldconfigdefaultscolorwithseriesby) + * [`obj mappings`](#obj-modelfieldconfigdefaultsmappings) + * [`obj RangeMap`](#obj-modelfieldconfigdefaultsmappingsrangemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsrangemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsrangemapoptions) + * [`fn withFrom(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionswithto) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsrangemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsrangemapoptionsresultwithtext) + * [`obj RegexMap`](#obj-modelfieldconfigdefaultsmappingsregexmap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsregexmapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsregexmapoptions) + * [`fn withPattern(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsregexmapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsregexmapoptionsresultwithtext) + * [`obj SpecialValueMap`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapwithtype) + * [`obj options`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptions) + * [`fn withMatch(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-modelfieldconfigdefaultsmappingsspecialvaluemapoptionsresultwithtext) + * [`obj ValueMap`](#obj-modelfieldconfigdefaultsmappingsvaluemap) + * [`fn withOptions(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-modelfieldconfigdefaultsmappingsvaluemapwithtype) + * [`obj thresholds`](#obj-modelfieldconfigdefaultsthresholds) + * [`fn withMode(value)`](#fn-modelfieldconfigdefaultsthresholdswithmode) + * [`fn withSteps(value)`](#fn-modelfieldconfigdefaultsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-modelfieldconfigdefaultsthresholdswithstepsmixin) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description +### fn withFolderUid + +```jsonnet +withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Folder UID +### fn withMeta + +```jsonnet +withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Object storage metadata +### fn withMetaMixin + +```jsonnet +withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Object storage metadata +### fn withModel + +```jsonnet +withModel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Dashboard panels are the basic visualization building blocks. +### fn withModelMixin + +```jsonnet +withModelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Dashboard panels are the basic visualization building blocks. +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel name (also saved in the model) +### fn withSchemaVersion + +```jsonnet +withSchemaVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Dashboard version when this was saved (zero if unknown) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel type (from inside the model) +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library element UID +### fn withVersion + +```jsonnet +withVersion(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +panel version, incremented each time the dashboard is updated. +### obj meta + + +#### fn meta.withConnectedDashboards + +```jsonnet +meta.withConnectedDashboards(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn meta.withCreated + +```jsonnet +meta.withCreated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withCreatedBy + +```jsonnet +meta.withCreatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withCreatedByMixin + +```jsonnet +meta.withCreatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withFolderName + +```jsonnet +meta.withFolderName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withFolderUid + +```jsonnet +meta.withFolderUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdated + +```jsonnet +meta.withUpdated(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn meta.withUpdatedBy + +```jsonnet +meta.withUpdatedBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn meta.withUpdatedByMixin + +```jsonnet +meta.withUpdatedByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj meta.createdBy + + +##### fn meta.createdBy.withAvatarUrl + +```jsonnet +meta.createdBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.createdBy.withId + +```jsonnet +meta.createdBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.createdBy.withName + +```jsonnet +meta.createdBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj meta.updatedBy + + +##### fn meta.updatedBy.withAvatarUrl + +```jsonnet +meta.updatedBy.withAvatarUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn meta.updatedBy.withId + +```jsonnet +meta.updatedBy.withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn meta.updatedBy.withName + +```jsonnet +meta.updatedBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj model + + +#### fn model.withCacheTimeout + +```jsonnet +model.withCacheTimeout(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets panel queries cache timeout. +#### fn model.withDatasource + +```jsonnet +model.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDatasourceMixin + +```jsonnet +model.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn model.withDescription + +```jsonnet +model.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn model.withFieldConfig + +```jsonnet +model.withFieldConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withFieldConfigMixin + +```jsonnet +model.withFieldConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +#### fn model.withHideTimeOverride + +```jsonnet +model.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn model.withInterval + +```jsonnet +model.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withLinks + +```jsonnet +model.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withLinksMixin + +```jsonnet +model.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn model.withMaxDataPoints + +```jsonnet +model.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn model.withMaxPerRow + +```jsonnet +model.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn model.withOptions + +```jsonnet +model.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withOptionsMixin + +```jsonnet +model.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +It depends on the panel plugin. They are specified by the Options field in panel plugin schemas. +#### fn model.withPluginVersion + +```jsonnet +model.withPluginVersion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs. +#### fn model.withQueryCachingTTL + +```jsonnet +model.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn model.withRepeat + +```jsonnet +model.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn model.withRepeatDirection + +```jsonnet +model.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn model.withTargets + +```jsonnet +model.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTargetsMixin + +```jsonnet +model.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn model.withTimeFrom + +```jsonnet +model.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTimeShift + +```jsonnet +model.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn model.withTitle + +```jsonnet +model.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn model.withTransformations + +```jsonnet +model.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransformationsMixin + +```jsonnet +model.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn model.withTransparent + +```jsonnet +model.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +#### fn model.withType + +```jsonnet +model.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The panel plugin type id. This is used to find the plugin to display the panel. +#### obj model.datasource + + +##### fn model.datasource.withType + +```jsonnet +model.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn model.datasource.withUid + +```jsonnet +model.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +#### obj model.fieldConfig + + +##### fn model.fieldConfig.withDefaults + +```jsonnet +model.fieldConfig.withDefaults(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withDefaultsMixin + +```jsonnet +model.fieldConfig.withDefaultsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. +Each column within this structure is called a field. A field can represent a single time series or table column. +Field options allow you to change how the data is displayed in your visualizations. +##### fn model.fieldConfig.withOverrides + +```jsonnet +model.fieldConfig.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### fn model.fieldConfig.withOverridesMixin + +```jsonnet +model.fieldConfig.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +##### obj model.fieldConfig.defaults + + +###### fn model.fieldConfig.defaults.withColor + +```jsonnet +model.fieldConfig.defaults.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withColorMixin + +```jsonnet +model.fieldConfig.defaults.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map a field to a color. +###### fn model.fieldConfig.defaults.withCustom + +```jsonnet +model.fieldConfig.defaults.withCustom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withCustomMixin + +```jsonnet +model.fieldConfig.defaults.withCustomMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +custom is specified by the FieldConfig field +in panel plugin schemas. +###### fn model.fieldConfig.defaults.withDecimals + +```jsonnet +model.fieldConfig.defaults.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +###### fn model.fieldConfig.defaults.withDescription + +```jsonnet +model.fieldConfig.defaults.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Human readable field metadata +###### fn model.fieldConfig.defaults.withDisplayName + +```jsonnet +model.fieldConfig.defaults.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +###### fn model.fieldConfig.defaults.withDisplayNameFromDS + +```jsonnet +model.fieldConfig.defaults.withDisplayNameFromDS(value) +``` + +PARAMETERS: + +* **value** (`string`) + +This can be used by data sources that return and explicit naming structure for values and labels +When this property is configured, this value is used rather than the default naming strategy. +###### fn model.fieldConfig.defaults.withFilterable + +```jsonnet +model.fieldConfig.defaults.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +###### fn model.fieldConfig.defaults.withLinks + +```jsonnet +model.fieldConfig.defaults.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withLinksMixin + +```jsonnet +model.fieldConfig.defaults.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +###### fn model.fieldConfig.defaults.withMappings + +```jsonnet +model.fieldConfig.defaults.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMappingsMixin + +```jsonnet +model.fieldConfig.defaults.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +###### fn model.fieldConfig.defaults.withMax + +```jsonnet +model.fieldConfig.defaults.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withMin + +```jsonnet +model.fieldConfig.defaults.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +###### fn model.fieldConfig.defaults.withNoValue + +```jsonnet +model.fieldConfig.defaults.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +###### fn model.fieldConfig.defaults.withPath + +```jsonnet +model.fieldConfig.defaults.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +###### fn model.fieldConfig.defaults.withThresholds + +```jsonnet +model.fieldConfig.defaults.withThresholds(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withThresholdsMixin + +```jsonnet +model.fieldConfig.defaults.withThresholdsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Thresholds configuration for the panel +###### fn model.fieldConfig.defaults.withUnit + +```jsonnet +model.fieldConfig.defaults.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +###### fn model.fieldConfig.defaults.withWriteable + +```jsonnet +model.fieldConfig.defaults.withWriteable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source can write a value to the path. Auth/authz are supported separately +###### obj model.fieldConfig.defaults.color + + +####### fn model.fieldConfig.defaults.color.withFixedColor + +```jsonnet +model.fieldConfig.defaults.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +####### fn model.fieldConfig.defaults.color.withMode + +```jsonnet +model.fieldConfig.defaults.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +####### fn model.fieldConfig.defaults.color.withSeriesBy + +```jsonnet +model.fieldConfig.defaults.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +###### obj model.fieldConfig.defaults.mappings + + +####### obj model.fieldConfig.defaults.mappings.RangeMap + + +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +######## fn model.fieldConfig.defaults.mappings.RangeMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RangeMap.options + + +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withFrom + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RangeMap.options.withTo + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +######### obj model.fieldConfig.defaults.mappings.RangeMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.RegexMap + + +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +######## fn model.fieldConfig.defaults.mappings.RegexMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.RegexMap.options + + +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withPattern + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.RegexMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.SpecialValueMap + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +######## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.withType() +``` + + + +######## obj model.fieldConfig.defaults.mappings.SpecialValueMap.options + + +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +######### obj model.fieldConfig.defaults.mappings.SpecialValueMap.options.result + + +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +########## fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText + +```jsonnet +model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +####### obj model.fieldConfig.defaults.mappings.ValueMap + + +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptions + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +######## fn model.fieldConfig.defaults.mappings.ValueMap.withType + +```jsonnet +model.fieldConfig.defaults.mappings.ValueMap.withType() +``` + + + +###### obj model.fieldConfig.defaults.thresholds + + +####### fn model.fieldConfig.defaults.thresholds.withMode + +```jsonnet +model.fieldConfig.defaults.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +####### fn model.fieldConfig.defaults.thresholds.withSteps + +```jsonnet +model.fieldConfig.defaults.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +####### fn model.fieldConfig.defaults.thresholds.withStepsMixin + +```jsonnet +model.fieldConfig.defaults.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/links.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/links.md new file mode 100644 index 0000000..fcc060a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md new file mode 100644 index 0000000..79d0a17 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/defaults/thresholds/steps.md @@ -0,0 +1,34 @@ +# steps + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/index.md new file mode 100644 index 0000000..35b01d5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/index.md @@ -0,0 +1,104 @@ +# overrides + + + +## Subpackages + +* [properties](properties.md) + +## Index + +* [`fn withMatcher(value)`](#fn-withmatcher) +* [`fn withMatcherMixin(value)`](#fn-withmatchermixin) +* [`fn withProperties(value)`](#fn-withproperties) +* [`fn withPropertiesMixin(value)`](#fn-withpropertiesmixin) +* [`obj matcher`](#obj-matcher) + * [`fn withId(value="")`](#fn-matcherwithid) + * [`fn withOptions(value)`](#fn-matcherwithoptions) + * [`fn withOptionsMixin(value)`](#fn-matcherwithoptionsmixin) + +## Fields + +### fn withMatcher + +```jsonnet +withMatcher(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withMatcherMixin + +```jsonnet +withMatcherMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withProperties + +```jsonnet +withProperties(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPropertiesMixin + +```jsonnet +withPropertiesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj matcher + + +#### fn matcher.withId + +```jsonnet +matcher.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn matcher.withOptions + +```jsonnet +matcher.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn matcher.withOptionsMixin + +```jsonnet +matcher.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/properties.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/properties.md new file mode 100644 index 0000000..766e198 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/fieldConfig/overrides/properties.md @@ -0,0 +1,45 @@ +# properties + + + +## Index + +* [`fn withId(value="")`](#fn-withid) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) + +## Fields + +### fn withId + +```jsonnet +withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/links.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/links.md new file mode 100644 index 0000000..fcc060a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/links.md @@ -0,0 +1,146 @@ +# links + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/transformations.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/transformations.md new file mode 100644 index 0000000..df55608 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/librarypanel/model/transformations.md @@ -0,0 +1,140 @@ +# transformations + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/index.md new file mode 100644 index 0000000..0061f5a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/index.md @@ -0,0 +1,1215 @@ +# alertList + +grafonnet.panel.alertList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlertListOptions(value)`](#fn-optionswithalertlistoptions) + * [`fn withAlertListOptionsMixin(value)`](#fn-optionswithalertlistoptionsmixin) + * [`fn withUnifiedAlertListOptions(value)`](#fn-optionswithunifiedalertlistoptions) + * [`fn withUnifiedAlertListOptionsMixin(value)`](#fn-optionswithunifiedalertlistoptionsmixin) + * [`obj AlertListOptions`](#obj-optionsalertlistoptions) + * [`fn withAlertName(value)`](#fn-optionsalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsalertlistoptionswithdashboardalerts) + * [`fn withDashboardTitle(value)`](#fn-optionsalertlistoptionswithdashboardtitle) + * [`fn withFolderId(value)`](#fn-optionsalertlistoptionswithfolderid) + * [`fn withMaxItems(value)`](#fn-optionsalertlistoptionswithmaxitems) + * [`fn withShowOptions(value)`](#fn-optionsalertlistoptionswithshowoptions) + * [`fn withSortOrder(value)`](#fn-optionsalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsalertlistoptionswithstatefiltermixin) + * [`fn withTags(value)`](#fn-optionsalertlistoptionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionsalertlistoptionswithtagsmixin) + * [`obj stateFilter`](#obj-optionsalertlistoptionsstatefilter) + * [`fn withAlerting(value=true)`](#fn-optionsalertlistoptionsstatefilterwithalerting) + * [`fn withExecutionError(value=true)`](#fn-optionsalertlistoptionsstatefilterwithexecutionerror) + * [`fn withNoData(value=true)`](#fn-optionsalertlistoptionsstatefilterwithnodata) + * [`fn withOk(value=true)`](#fn-optionsalertlistoptionsstatefilterwithok) + * [`fn withPaused(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpaused) + * [`fn withPending(value=true)`](#fn-optionsalertlistoptionsstatefilterwithpending) + * [`obj UnifiedAlertListOptions`](#obj-optionsunifiedalertlistoptions) + * [`fn withAlertInstanceLabelFilter(value)`](#fn-optionsunifiedalertlistoptionswithalertinstancelabelfilter) + * [`fn withAlertName(value)`](#fn-optionsunifiedalertlistoptionswithalertname) + * [`fn withDashboardAlerts(value=true)`](#fn-optionsunifiedalertlistoptionswithdashboardalerts) + * [`fn withDatasource(value)`](#fn-optionsunifiedalertlistoptionswithdatasource) + * [`fn withFolder(value)`](#fn-optionsunifiedalertlistoptionswithfolder) + * [`fn withFolderMixin(value)`](#fn-optionsunifiedalertlistoptionswithfoldermixin) + * [`fn withGroupBy(value)`](#fn-optionsunifiedalertlistoptionswithgroupby) + * [`fn withGroupByMixin(value)`](#fn-optionsunifiedalertlistoptionswithgroupbymixin) + * [`fn withGroupMode(value)`](#fn-optionsunifiedalertlistoptionswithgroupmode) + * [`fn withMaxItems(value)`](#fn-optionsunifiedalertlistoptionswithmaxitems) + * [`fn withShowInstances(value=true)`](#fn-optionsunifiedalertlistoptionswithshowinstances) + * [`fn withSortOrder(value)`](#fn-optionsunifiedalertlistoptionswithsortorder) + * [`fn withStateFilter(value)`](#fn-optionsunifiedalertlistoptionswithstatefilter) + * [`fn withStateFilterMixin(value)`](#fn-optionsunifiedalertlistoptionswithstatefiltermixin) + * [`fn withViewMode(value)`](#fn-optionsunifiedalertlistoptionswithviewmode) + * [`obj folder`](#obj-optionsunifiedalertlistoptionsfolder) + * [`fn withId(value)`](#fn-optionsunifiedalertlistoptionsfolderwithid) + * [`fn withTitle(value)`](#fn-optionsunifiedalertlistoptionsfolderwithtitle) + * [`obj stateFilter`](#obj-optionsunifiedalertlistoptionsstatefilter) + * [`fn withError(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwitherror) + * [`fn withFiring(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithfiring) + * [`fn withInactive(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithinactive) + * [`fn withNoData(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnodata) + * [`fn withNormal(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithnormal) + * [`fn withPending(value=true)`](#fn-optionsunifiedalertlistoptionsstatefilterwithpending) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new alertlist panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlertListOptions + +```jsonnet +options.withAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withAlertListOptionsMixin + +```jsonnet +options.withAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptions + +```jsonnet +options.withUnifiedAlertListOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withUnifiedAlertListOptionsMixin + +```jsonnet +options.withUnifiedAlertListOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.AlertListOptions + + +##### fn options.AlertListOptions.withAlertName + +```jsonnet +options.AlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withDashboardAlerts + +```jsonnet +options.AlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.AlertListOptions.withDashboardTitle + +```jsonnet +options.AlertListOptions.withDashboardTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.AlertListOptions.withFolderId + +```jsonnet +options.AlertListOptions.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withMaxItems + +```jsonnet +options.AlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.AlertListOptions.withShowOptions + +```jsonnet +options.AlertListOptions.withShowOptions(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"current"`, `"changes"` + + +##### fn options.AlertListOptions.withSortOrder + +```jsonnet +options.AlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.AlertListOptions.withStateFilter + +```jsonnet +options.AlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withStateFilterMixin + +```jsonnet +options.AlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.AlertListOptions.withTags + +```jsonnet +options.AlertListOptions.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.AlertListOptions.withTagsMixin + +```jsonnet +options.AlertListOptions.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### obj options.AlertListOptions.stateFilter + + +###### fn options.AlertListOptions.stateFilter.withAlerting + +```jsonnet +options.AlertListOptions.stateFilter.withAlerting(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withExecutionError + +```jsonnet +options.AlertListOptions.stateFilter.withExecutionError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withNoData + +```jsonnet +options.AlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withOk + +```jsonnet +options.AlertListOptions.stateFilter.withOk(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPaused + +```jsonnet +options.AlertListOptions.stateFilter.withPaused(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.AlertListOptions.stateFilter.withPending + +```jsonnet +options.AlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.UnifiedAlertListOptions + + +##### fn options.UnifiedAlertListOptions.withAlertInstanceLabelFilter + +```jsonnet +options.UnifiedAlertListOptions.withAlertInstanceLabelFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withAlertName + +```jsonnet +options.UnifiedAlertListOptions.withAlertName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withDashboardAlerts + +```jsonnet +options.UnifiedAlertListOptions.withDashboardAlerts(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withDatasource + +```jsonnet +options.UnifiedAlertListOptions.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.UnifiedAlertListOptions.withFolder + +```jsonnet +options.UnifiedAlertListOptions.withFolder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withFolderMixin + +```jsonnet +options.UnifiedAlertListOptions.withFolderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withGroupBy + +```jsonnet +options.UnifiedAlertListOptions.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupByMixin + +```jsonnet +options.UnifiedAlertListOptions.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.UnifiedAlertListOptions.withGroupMode + +```jsonnet +options.UnifiedAlertListOptions.withGroupMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"default"`, `"custom"` + + +##### fn options.UnifiedAlertListOptions.withMaxItems + +```jsonnet +options.UnifiedAlertListOptions.withMaxItems(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.UnifiedAlertListOptions.withShowInstances + +```jsonnet +options.UnifiedAlertListOptions.withShowInstances(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.UnifiedAlertListOptions.withSortOrder + +```jsonnet +options.UnifiedAlertListOptions.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`number`) + - valid values: `1`, `2`, `3`, `4`, `5` + + +##### fn options.UnifiedAlertListOptions.withStateFilter + +```jsonnet +options.UnifiedAlertListOptions.withStateFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withStateFilterMixin + +```jsonnet +options.UnifiedAlertListOptions.withStateFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn options.UnifiedAlertListOptions.withViewMode + +```jsonnet +options.UnifiedAlertListOptions.withViewMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"stat"` + + +##### obj options.UnifiedAlertListOptions.folder + + +###### fn options.UnifiedAlertListOptions.folder.withId + +```jsonnet +options.UnifiedAlertListOptions.folder.withId(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.UnifiedAlertListOptions.folder.withTitle + +```jsonnet +options.UnifiedAlertListOptions.folder.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.UnifiedAlertListOptions.stateFilter + + +###### fn options.UnifiedAlertListOptions.stateFilter.withError + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withError(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withFiring + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withFiring(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withInactive + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withInactive(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNoData + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNoData(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withNormal + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withNormal(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn options.UnifiedAlertListOptions.stateFilter.withPending + +```jsonnet +options.UnifiedAlertListOptions.stateFilter.withPending(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/alertList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/index.md new file mode 100644 index 0000000..0cd1707 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/index.md @@ -0,0 +1,788 @@ +# annotationsList + +grafonnet.panel.annotationsList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLimit(value=10)`](#fn-optionswithlimit) + * [`fn withNavigateAfter(value="10m")`](#fn-optionswithnavigateafter) + * [`fn withNavigateBefore(value="10m")`](#fn-optionswithnavigatebefore) + * [`fn withNavigateToPanel(value=true)`](#fn-optionswithnavigatetopanel) + * [`fn withOnlyFromThisDashboard(value=true)`](#fn-optionswithonlyfromthisdashboard) + * [`fn withOnlyInTimeRange(value=true)`](#fn-optionswithonlyintimerange) + * [`fn withShowTags(value=true)`](#fn-optionswithshowtags) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withShowUser(value=true)`](#fn-optionswithshowuser) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new annotationsList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLimit + +```jsonnet +options.withLimit(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withNavigateAfter + +```jsonnet +options.withNavigateAfter(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateBefore + +```jsonnet +options.withNavigateBefore(value="10m") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"10m"` + + +#### fn options.withNavigateToPanel + +```jsonnet +options.withNavigateToPanel(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyFromThisDashboard + +```jsonnet +options.withOnlyFromThisDashboard(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withOnlyInTimeRange + +```jsonnet +options.withOnlyInTimeRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTags + +```jsonnet +options.withShowTags(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowUser + +```jsonnet +options.withShowUser(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/annotationsList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/index.md new file mode 100644 index 0000000..327ef01 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/index.md @@ -0,0 +1,1432 @@ +# barChart + +grafonnet.panel.barChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value="none")`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBarRadius(value=0)`](#fn-optionswithbarradius) + * [`fn withBarWidth(value=0.97)`](#fn-optionswithbarwidth) + * [`fn withColorByField(value)`](#fn-optionswithcolorbyfield) + * [`fn withFullHighlight(value=true)`](#fn-optionswithfullhighlight) + * [`fn withGroupWidth(value=0.7)`](#fn-optionswithgroupwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value="auto")`](#fn-optionswithorientation) + * [`fn withShowValue(value="auto")`](#fn-optionswithshowvalue) + * [`fn withStacking(value="none")`](#fn-optionswithstacking) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`fn withXTickLabelMaxLength(value)`](#fn-optionswithxticklabelmaxlength) + * [`fn withXTickLabelRotation(value=0)`](#fn-optionswithxticklabelrotation) + * [`fn withXTickLabelSpacing(value=0)`](#fn-optionswithxticklabelspacing) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value="none") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"none"` + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBarRadius + +```jsonnet +options.withBarRadius(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Controls the radius of each bar. +#### fn options.withBarWidth + +```jsonnet +options.withBarWidth(value=0.97) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.97` + +Controls the width of bars. 1 = Max width, 0 = Min width. +#### fn options.withColorByField + +```jsonnet +options.withColorByField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use the color value for a sibling field to color each bar value. +#### fn options.withFullHighlight + +```jsonnet +options.withFullHighlight(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enables mode which highlights the entire bar area and shows tooltip when cursor +hovers over highlighted area +#### fn options.withGroupWidth + +```jsonnet +options.withGroupWidth(value=0.7) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.7` + +Controls the width of groups. 1 = max with, 0 = min width. +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withStacking + +```jsonnet +options.withStacking(value="none") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"none"` + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Manually select which field from the dataset to represent the x field. +#### fn options.withXTickLabelMaxLength + +```jsonnet +options.withXTickLabelMaxLength(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the max length that a label can have before it is truncated. +#### fn options.withXTickLabelRotation + +```jsonnet +options.withXTickLabelRotation(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the rotation of the x axis labels. +#### fn options.withXTickLabelSpacing + +```jsonnet +options.withXTickLabelSpacing(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + +Controls the spacing between x axis labels. +negative values indicate backwards skipping behavior +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/index.md new file mode 100644 index 0000000..326fdcc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/index.md @@ -0,0 +1,1069 @@ +# barGauge + +grafonnet.panel.barGauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayMode(value="gradient")`](#fn-optionswithdisplaymode) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMaxVizHeight(value=300)`](#fn-optionswithmaxvizheight) + * [`fn withMinVizHeight(value=16)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=8)`](#fn-optionswithminvizwidth) + * [`fn withNamePlacement(value="auto")`](#fn-optionswithnameplacement) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowUnfilled(value=true)`](#fn-optionswithshowunfilled) + * [`fn withSizing(value="auto")`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withValueMode(value="color")`](#fn-optionswithvaluemode) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new barGauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayMode + +```jsonnet +options.withDisplayMode(value="gradient") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"gradient"` + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMaxVizHeight + +```jsonnet +options.withMaxVizHeight(value=300) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `300` + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=16) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `16` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=8) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `8` + + +#### fn options.withNamePlacement + +```jsonnet +options.withNamePlacement(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"top"`, `"left"`, `"hidden"` + +Allows for the bar gauge name to be placed explicitly +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowUnfilled + +```jsonnet +options.withShowUnfilled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withValueMode + +```jsonnet +options.withValueMode(value="color") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"color"` + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/barGauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/index.md new file mode 100644 index 0000000..96629fa --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/index.md @@ -0,0 +1,1762 @@ +# candlestick + +grafonnet.panel.candlestick + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCandleStyle(value="candles")`](#fn-optionswithcandlestyle) + * [`fn withColorStrategy(value="open-close")`](#fn-optionswithcolorstrategy) + * [`fn withColors(value={"down": "red","flat": "gray","up": "green"})`](#fn-optionswithcolors) + * [`fn withColorsMixin(value={"down": "red","flat": "gray","up": "green"})`](#fn-optionswithcolorsmixin) + * [`fn withFields(value)`](#fn-optionswithfields) + * [`fn withFieldsMixin(value)`](#fn-optionswithfieldsmixin) + * [`fn withIncludeAllFields(value=true)`](#fn-optionswithincludeallfields) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMode(value="candles+volume")`](#fn-optionswithmode) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj colors`](#obj-optionscolors) + * [`fn withDown(value="red")`](#fn-optionscolorswithdown) + * [`fn withFlat(value="gray")`](#fn-optionscolorswithflat) + * [`fn withUp(value="green")`](#fn-optionscolorswithup) + * [`obj fields`](#obj-optionsfields) + * [`fn withClose(value)`](#fn-optionsfieldswithclose) + * [`fn withHigh(value)`](#fn-optionsfieldswithhigh) + * [`fn withLow(value)`](#fn-optionsfieldswithlow) + * [`fn withOpen(value)`](#fn-optionsfieldswithopen) + * [`fn withVolume(value)`](#fn-optionsfieldswithvolume) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new candlestick panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCandleStyle + +```jsonnet +options.withCandleStyle(value="candles") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"candles"` + - valid values: `"candles"`, `"ohlcbars"` + +Sets the style of the candlesticks +#### fn options.withColorStrategy + +```jsonnet +options.withColorStrategy(value="open-close") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"open-close"` + - valid values: `"open-close"`, `"close-close"` + +Sets the color strategy for the candlesticks +#### fn options.withColors + +```jsonnet +options.withColors(value={"down": "red","flat": "gray","up": "green"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"down": "red","flat": "gray","up": "green"}` + +Set which colors are used when the price movement is up or down +#### fn options.withColorsMixin + +```jsonnet +options.withColorsMixin(value={"down": "red","flat": "gray","up": "green"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"down": "red","flat": "gray","up": "green"}` + +Set which colors are used when the price movement is up or down +#### fn options.withFields + +```jsonnet +options.withFields(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map fields to appropriate dimension +#### fn options.withFieldsMixin + +```jsonnet +options.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map fields to appropriate dimension +#### fn options.withIncludeAllFields + +```jsonnet +options.withIncludeAllFields(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +When enabled, all fields will be sent to the graph +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMode + +```jsonnet +options.withMode(value="candles+volume") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"candles+volume"` + - valid values: `"candles+volume"`, `"candles"`, `"volume"` + +Sets which dimensions are used for the visualization +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.colors + + +##### fn options.colors.withDown + +```jsonnet +options.colors.withDown(value="red") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"red"` + + +##### fn options.colors.withFlat + +```jsonnet +options.colors.withFlat(value="gray") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"gray"` + + +##### fn options.colors.withUp + +```jsonnet +options.colors.withUp(value="green") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"green"` + + +#### obj options.fields + + +##### fn options.fields.withClose + +```jsonnet +options.fields.withClose(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the final (end) value of the given period +##### fn options.fields.withHigh + +```jsonnet +options.fields.withHigh(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the highest value of the given period +##### fn options.fields.withLow + +```jsonnet +options.fields.withLow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the lowest value of the given period +##### fn options.fields.withOpen + +```jsonnet +options.fields.withOpen(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the starting value of the given period +##### fn options.fields.withVolume + +```jsonnet +options.fields.withVolume(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Corresponds to the sample count in the given period. (e.g. number of trades) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/candlestick/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/index.md new file mode 100644 index 0000000..3fa434f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/index.md @@ -0,0 +1,775 @@ +# canvas + +grafonnet.panel.canvas + +## Subpackages + +* [options.root.elements](options/root/elements/index.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withInfinitePan(value=true)`](#fn-optionswithinfinitepan) + * [`fn withInlineEditing(value=true)`](#fn-optionswithinlineediting) + * [`fn withPanZoom(value=true)`](#fn-optionswithpanzoom) + * [`fn withRoot(value)`](#fn-optionswithroot) + * [`fn withRootMixin(value)`](#fn-optionswithrootmixin) + * [`fn withShowAdvancedTypes(value=true)`](#fn-optionswithshowadvancedtypes) + * [`obj root`](#obj-optionsroot) + * [`fn withElements(value)`](#fn-optionsrootwithelements) + * [`fn withElementsMixin(value)`](#fn-optionsrootwithelementsmixin) + * [`fn withName(value)`](#fn-optionsrootwithname) + * [`fn withType()`](#fn-optionsrootwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new canvas panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withInfinitePan + +```jsonnet +options.withInfinitePan(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable infinite pan +#### fn options.withInlineEditing + +```jsonnet +options.withInlineEditing(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable inline editing +#### fn options.withPanZoom + +```jsonnet +options.withPanZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable pan and zoom +#### fn options.withRoot + +```jsonnet +options.withRoot(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withRootMixin + +```jsonnet +options.withRootMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The root element of canvas (frame), where all canvas elements are nested +TODO: Figure out how to define a default value for this +#### fn options.withShowAdvancedTypes + +```jsonnet +options.withShowAdvancedTypes(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show all available element types +#### obj options.root + + +##### fn options.root.withElements + +```jsonnet +options.root.withElements(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withElementsMixin + +```jsonnet +options.root.withElementsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The list of canvas elements attached to the root element +##### fn options.root.withName + +```jsonnet +options.root.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the root element +##### fn options.root.withType + +```jsonnet +options.root.withType() +``` + + +Type of root element (frame) +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/index.md new file mode 100644 index 0000000..11041b6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/index.md @@ -0,0 +1,410 @@ +# connections + + + +## Subpackages + +* [vertices](vertices.md) + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withColorMixin(value)`](#fn-withcolormixin) +* [`fn withPath(value)`](#fn-withpath) +* [`fn withSize(value)`](#fn-withsize) +* [`fn withSizeMixin(value)`](#fn-withsizemixin) +* [`fn withSource(value)`](#fn-withsource) +* [`fn withSourceMixin(value)`](#fn-withsourcemixin) +* [`fn withSourceOriginal(value)`](#fn-withsourceoriginal) +* [`fn withSourceOriginalMixin(value)`](#fn-withsourceoriginalmixin) +* [`fn withTarget(value)`](#fn-withtarget) +* [`fn withTargetMixin(value)`](#fn-withtargetmixin) +* [`fn withTargetName(value)`](#fn-withtargetname) +* [`fn withTargetOriginal(value)`](#fn-withtargetoriginal) +* [`fn withTargetOriginalMixin(value)`](#fn-withtargetoriginalmixin) +* [`fn withVertices(value)`](#fn-withvertices) +* [`fn withVerticesMixin(value)`](#fn-withverticesmixin) +* [`obj color`](#obj-color) + * [`fn withField(value)`](#fn-colorwithfield) + * [`fn withFixed(value)`](#fn-colorwithfixed) +* [`obj size`](#obj-size) + * [`fn withField(value)`](#fn-sizewithfield) + * [`fn withFixed(value)`](#fn-sizewithfixed) + * [`fn withMax(value)`](#fn-sizewithmax) + * [`fn withMin(value)`](#fn-sizewithmin) + * [`fn withMode(value)`](#fn-sizewithmode) +* [`obj source`](#obj-source) + * [`fn withX(value)`](#fn-sourcewithx) + * [`fn withY(value)`](#fn-sourcewithy) +* [`obj sourceOriginal`](#obj-sourceoriginal) + * [`fn withX(value)`](#fn-sourceoriginalwithx) + * [`fn withY(value)`](#fn-sourceoriginalwithy) +* [`obj target`](#obj-target) + * [`fn withX(value)`](#fn-targetwithx) + * [`fn withY(value)`](#fn-targetwithy) +* [`obj targetOriginal`](#obj-targetoriginal) + * [`fn withX(value)`](#fn-targetoriginalwithx) + * [`fn withY(value)`](#fn-targetoriginalwithy) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withColorMixin + +```jsonnet +withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPath + +```jsonnet +withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"straight"` + + +### fn withSize + +```jsonnet +withSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSizeMixin + +```jsonnet +withSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSource + +```jsonnet +withSource(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceMixin + +```jsonnet +withSourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginal + +```jsonnet +withSourceOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSourceOriginalMixin + +```jsonnet +withSourceOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTarget + +```jsonnet +withTarget(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetMixin + +```jsonnet +withTargetMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetName + +```jsonnet +withTargetName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTargetOriginal + +```jsonnet +withTargetOriginal(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTargetOriginalMixin + +```jsonnet +withTargetOriginalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withVertices + +```jsonnet +withVertices(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withVerticesMixin + +```jsonnet +withVerticesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj color + + +#### fn color.withField + +```jsonnet +color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn color.withFixed + +```jsonnet +color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj size + + +#### fn size.withField + +```jsonnet +size.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn size.withFixed + +```jsonnet +size.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMax + +```jsonnet +size.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMin + +```jsonnet +size.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn size.withMode + +```jsonnet +size.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + +| *"linear" +### obj source + + +#### fn source.withX + +```jsonnet +source.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn source.withY + +```jsonnet +source.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj sourceOriginal + + +#### fn sourceOriginal.withX + +```jsonnet +sourceOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn sourceOriginal.withY + +```jsonnet +sourceOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj target + + +#### fn target.withX + +```jsonnet +target.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn target.withY + +```jsonnet +target.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### obj targetOriginal + + +#### fn targetOriginal.withX + +```jsonnet +targetOriginal.withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn targetOriginal.withY + +```jsonnet +targetOriginal.withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/vertices.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/vertices.md new file mode 100644 index 0000000..70f44a3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/connections/vertices.md @@ -0,0 +1,32 @@ +# vertices + + + +## Index + +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) + +## Fields + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/index.md new file mode 100644 index 0000000..73f5b6e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/options/root/elements/index.md @@ -0,0 +1,512 @@ +# elements + + + +## Subpackages + +* [connections](connections/index.md) + +## Index + +* [`fn withBackground(value)`](#fn-withbackground) +* [`fn withBackgroundMixin(value)`](#fn-withbackgroundmixin) +* [`fn withBorder(value)`](#fn-withborder) +* [`fn withBorderMixin(value)`](#fn-withbordermixin) +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withConnections(value)`](#fn-withconnections) +* [`fn withConnectionsMixin(value)`](#fn-withconnectionsmixin) +* [`fn withConstraint(value)`](#fn-withconstraint) +* [`fn withConstraintMixin(value)`](#fn-withconstraintmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withPlacement(value)`](#fn-withplacement) +* [`fn withPlacementMixin(value)`](#fn-withplacementmixin) +* [`fn withType(value)`](#fn-withtype) +* [`obj background`](#obj-background) + * [`fn withColor(value)`](#fn-backgroundwithcolor) + * [`fn withColorMixin(value)`](#fn-backgroundwithcolormixin) + * [`fn withImage(value)`](#fn-backgroundwithimage) + * [`fn withImageMixin(value)`](#fn-backgroundwithimagemixin) + * [`fn withSize(value)`](#fn-backgroundwithsize) + * [`obj color`](#obj-backgroundcolor) + * [`fn withField(value)`](#fn-backgroundcolorwithfield) + * [`fn withFixed(value)`](#fn-backgroundcolorwithfixed) + * [`obj image`](#obj-backgroundimage) + * [`fn withField(value)`](#fn-backgroundimagewithfield) + * [`fn withFixed(value)`](#fn-backgroundimagewithfixed) + * [`fn withMode(value)`](#fn-backgroundimagewithmode) +* [`obj border`](#obj-border) + * [`fn withColor(value)`](#fn-borderwithcolor) + * [`fn withColorMixin(value)`](#fn-borderwithcolormixin) + * [`fn withRadius(value)`](#fn-borderwithradius) + * [`fn withWidth(value)`](#fn-borderwithwidth) + * [`obj color`](#obj-bordercolor) + * [`fn withField(value)`](#fn-bordercolorwithfield) + * [`fn withFixed(value)`](#fn-bordercolorwithfixed) +* [`obj constraint`](#obj-constraint) + * [`fn withHorizontal(value)`](#fn-constraintwithhorizontal) + * [`fn withVertical(value)`](#fn-constraintwithvertical) +* [`obj placement`](#obj-placement) + * [`fn withBottom(value)`](#fn-placementwithbottom) + * [`fn withHeight(value)`](#fn-placementwithheight) + * [`fn withLeft(value)`](#fn-placementwithleft) + * [`fn withRight(value)`](#fn-placementwithright) + * [`fn withRotation(value)`](#fn-placementwithrotation) + * [`fn withTop(value)`](#fn-placementwithtop) + * [`fn withWidth(value)`](#fn-placementwithwidth) + +## Fields + +### fn withBackground + +```jsonnet +withBackground(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBackgroundMixin + +```jsonnet +withBackgroundMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorder + +```jsonnet +withBorder(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withBorderMixin + +```jsonnet +withBorderMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define this (element config(s)) +### fn withConnections + +```jsonnet +withConnections(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConnectionsMixin + +```jsonnet +withConnectionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConstraint + +```jsonnet +withConstraint(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConstraintMixin + +```jsonnet +withConstraintMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPlacement + +```jsonnet +withPlacement(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPlacementMixin + +```jsonnet +withPlacementMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj background + + +#### fn background.withColor + +```jsonnet +background.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withColorMixin + +```jsonnet +background.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn background.withImage + +```jsonnet +background.withImage(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withImageMixin + +```jsonnet +background.withImageMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Links to a resource (image/svg path) +#### fn background.withSize + +```jsonnet +background.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"original"`, `"contain"`, `"cover"`, `"fill"`, `"tile"` + + +#### obj background.color + + +##### fn background.color.withField + +```jsonnet +background.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.color.withFixed + +```jsonnet +background.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +#### obj background.image + + +##### fn background.image.withField + +```jsonnet +background.image.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn background.image.withFixed + +```jsonnet +background.image.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn background.image.withMode + +```jsonnet +background.image.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"mapping"` + + +### obj border + + +#### fn border.withColor + +```jsonnet +border.withColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withColorMixin + +```jsonnet +border.withColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn border.withRadius + +```jsonnet +border.withRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn border.withWidth + +```jsonnet +border.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj border.color + + +##### fn border.color.withField + +```jsonnet +border.color.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +##### fn border.color.withFixed + +```jsonnet +border.color.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj constraint + + +#### fn constraint.withHorizontal + +```jsonnet +constraint.withHorizontal(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"left"`, `"right"`, `"leftright"`, `"center"`, `"scale"` + + +#### fn constraint.withVertical + +```jsonnet +constraint.withVertical(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"top"`, `"bottom"`, `"topbottom"`, `"center"`, `"scale"` + + +### obj placement + + +#### fn placement.withBottom + +```jsonnet +placement.withBottom(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withHeight + +```jsonnet +placement.withHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withLeft + +```jsonnet +placement.withLeft(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRight + +```jsonnet +placement.withRight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withRotation + +```jsonnet +placement.withRotation(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withTop + +```jsonnet +placement.withTop(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn placement.withWidth + +```jsonnet +placement.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/canvas/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/index.md new file mode 100644 index 0000000..db9518b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/index.md @@ -0,0 +1,812 @@ +# dashboardList + +grafonnet.panel.dashboardList + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFolderId(value)`](#fn-optionswithfolderid) + * [`fn withFolderUID(value)`](#fn-optionswithfolderuid) + * [`fn withIncludeVars(value=true)`](#fn-optionswithincludevars) + * [`fn withKeepTime(value=true)`](#fn-optionswithkeeptime) + * [`fn withMaxItems(value=10)`](#fn-optionswithmaxitems) + * [`fn withQuery(value="")`](#fn-optionswithquery) + * [`fn withShowFolderNames(value=true)`](#fn-optionswithshowfoldernames) + * [`fn withShowHeadings(value=true)`](#fn-optionswithshowheadings) + * [`fn withShowRecentlyViewed(value=true)`](#fn-optionswithshowrecentlyviewed) + * [`fn withShowSearch(value=true)`](#fn-optionswithshowsearch) + * [`fn withShowStarred(value=true)`](#fn-optionswithshowstarred) + * [`fn withTags(value)`](#fn-optionswithtags) + * [`fn withTagsMixin(value)`](#fn-optionswithtagsmixin) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new dashboardList panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFolderId + +```jsonnet +options.withFolderId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +folderId is deprecated, and migrated to folderUid on panel init +#### fn options.withFolderUID + +```jsonnet +options.withFolderUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn options.withIncludeVars + +```jsonnet +options.withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withKeepTime + +```jsonnet +options.withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withMaxItems + +```jsonnet +options.withMaxItems(value=10) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `10` + + +#### fn options.withQuery + +```jsonnet +options.withQuery(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +#### fn options.withShowFolderNames + +```jsonnet +options.withShowFolderNames(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowHeadings + +```jsonnet +options.withShowHeadings(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowRecentlyViewed + +```jsonnet +options.withShowRecentlyViewed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowSearch + +```jsonnet +options.withShowSearch(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowStarred + +```jsonnet +options.withShowStarred(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withTags + +```jsonnet +options.withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTagsMixin + +```jsonnet +options.withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/dashboardList/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/index.md new file mode 100644 index 0000000..a8832f7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/index.md @@ -0,0 +1,660 @@ +# datagrid + +grafonnet.panel.datagrid + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withSelectedSeries(value=0)`](#fn-optionswithselectedseries) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new datagrid panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withSelectedSeries + +```jsonnet +options.withSelectedSeries(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/datagrid/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/index.md new file mode 100644 index 0000000..3eb99e1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/index.md @@ -0,0 +1,727 @@ +# debug + +grafonnet.panel.debug + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCounters(value)`](#fn-optionswithcounters) + * [`fn withCountersMixin(value)`](#fn-optionswithcountersmixin) + * [`fn withMode(value)`](#fn-optionswithmode) + * [`obj counters`](#obj-optionscounters) + * [`fn withDataChanged(value=true)`](#fn-optionscounterswithdatachanged) + * [`fn withRender(value=true)`](#fn-optionscounterswithrender) + * [`fn withSchemaChanged(value=true)`](#fn-optionscounterswithschemachanged) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new debug panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCounters + +```jsonnet +options.withCounters(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCountersMixin + +```jsonnet +options.withCountersMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withMode + +```jsonnet +options.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"render"`, `"events"`, `"cursor"`, `"State"`, `"ThrowError"` + + +#### obj options.counters + + +##### fn options.counters.withDataChanged + +```jsonnet +options.counters.withDataChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withRender + +```jsonnet +options.counters.withRender(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.counters.withSchemaChanged + +```jsonnet +options.counters.withSchemaChanged(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/debug/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/index.md new file mode 100644 index 0000000..ae4729f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/index.md @@ -0,0 +1,867 @@ +# gauge + +grafonnet.panel.gauge + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withMinVizHeight(value=75)`](#fn-optionswithminvizheight) + * [`fn withMinVizWidth(value=75)`](#fn-optionswithminvizwidth) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowThresholdLabels(value=true)`](#fn-optionswithshowthresholdlabels) + * [`fn withShowThresholdMarkers(value=true)`](#fn-optionswithshowthresholdmarkers) + * [`fn withSizing(value="auto")`](#fn-optionswithsizing) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new gauge panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withMinVizHeight + +```jsonnet +options.withMinVizHeight(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withMinVizWidth + +```jsonnet +options.withMinVizWidth(value=75) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `75` + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowThresholdLabels + +```jsonnet +options.withShowThresholdLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowThresholdMarkers + +```jsonnet +options.withShowThresholdMarkers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSizing + +```jsonnet +options.withSizing(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"manual"` + +Allows for the bar gauge size to be set explicitly +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/gauge/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/index.md new file mode 100644 index 0000000..d9335f0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/index.md @@ -0,0 +1,1226 @@ +# geomap + +grafonnet.panel.geomap + +## Subpackages + +* [options.layers](options/layers.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBasemap(value)`](#fn-optionswithbasemap) + * [`fn withBasemapMixin(value)`](#fn-optionswithbasemapmixin) + * [`fn withControls(value)`](#fn-optionswithcontrols) + * [`fn withControlsMixin(value)`](#fn-optionswithcontrolsmixin) + * [`fn withLayers(value)`](#fn-optionswithlayers) + * [`fn withLayersMixin(value)`](#fn-optionswithlayersmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withView(value)`](#fn-optionswithview) + * [`fn withViewMixin(value)`](#fn-optionswithviewmixin) + * [`obj basemap`](#obj-optionsbasemap) + * [`fn withConfig(value)`](#fn-optionsbasemapwithconfig) + * [`fn withConfigMixin(value)`](#fn-optionsbasemapwithconfigmixin) + * [`fn withFilterData(value)`](#fn-optionsbasemapwithfilterdata) + * [`fn withFilterDataMixin(value)`](#fn-optionsbasemapwithfilterdatamixin) + * [`fn withLocation(value)`](#fn-optionsbasemapwithlocation) + * [`fn withLocationMixin(value)`](#fn-optionsbasemapwithlocationmixin) + * [`fn withName(value)`](#fn-optionsbasemapwithname) + * [`fn withOpacity(value)`](#fn-optionsbasemapwithopacity) + * [`fn withTooltip(value=true)`](#fn-optionsbasemapwithtooltip) + * [`fn withType(value)`](#fn-optionsbasemapwithtype) + * [`obj location`](#obj-optionsbasemaplocation) + * [`fn withGazetteer(value)`](#fn-optionsbasemaplocationwithgazetteer) + * [`fn withGeohash(value)`](#fn-optionsbasemaplocationwithgeohash) + * [`fn withLatitude(value)`](#fn-optionsbasemaplocationwithlatitude) + * [`fn withLongitude(value)`](#fn-optionsbasemaplocationwithlongitude) + * [`fn withLookup(value)`](#fn-optionsbasemaplocationwithlookup) + * [`fn withMode(value)`](#fn-optionsbasemaplocationwithmode) + * [`fn withWkt(value)`](#fn-optionsbasemaplocationwithwkt) + * [`obj controls`](#obj-optionscontrols) + * [`fn withMouseWheelZoom(value=true)`](#fn-optionscontrolswithmousewheelzoom) + * [`fn withShowAttribution(value=true)`](#fn-optionscontrolswithshowattribution) + * [`fn withShowDebug(value=true)`](#fn-optionscontrolswithshowdebug) + * [`fn withShowMeasure(value=true)`](#fn-optionscontrolswithshowmeasure) + * [`fn withShowScale(value=true)`](#fn-optionscontrolswithshowscale) + * [`fn withShowZoom(value=true)`](#fn-optionscontrolswithshowzoom) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`obj view`](#obj-optionsview) + * [`fn withAllLayers(value=true)`](#fn-optionsviewwithalllayers) + * [`fn withId(value="zero")`](#fn-optionsviewwithid) + * [`fn withLastOnly(value=true)`](#fn-optionsviewwithlastonly) + * [`fn withLat(value=0)`](#fn-optionsviewwithlat) + * [`fn withLayer(value)`](#fn-optionsviewwithlayer) + * [`fn withLon(value=0)`](#fn-optionsviewwithlon) + * [`fn withMaxZoom(value)`](#fn-optionsviewwithmaxzoom) + * [`fn withMinZoom(value)`](#fn-optionsviewwithminzoom) + * [`fn withPadding(value)`](#fn-optionsviewwithpadding) + * [`fn withShared(value=true)`](#fn-optionsviewwithshared) + * [`fn withZoom(value=1)`](#fn-optionsviewwithzoom) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new geomap panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBasemap + +```jsonnet +options.withBasemap(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withBasemapMixin + +```jsonnet +options.withBasemapMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControls + +```jsonnet +options.withControls(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withControlsMixin + +```jsonnet +options.withControlsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLayers + +```jsonnet +options.withLayers(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLayersMixin + +```jsonnet +options.withLayersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withView + +```jsonnet +options.withView(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withViewMixin + +```jsonnet +options.withViewMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.basemap + + +##### fn options.basemap.withConfig + +```jsonnet +options.basemap.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withConfigMixin + +```jsonnet +options.basemap.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +##### fn options.basemap.withFilterData + +```jsonnet +options.basemap.withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withFilterDataMixin + +```jsonnet +options.basemap.withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +##### fn options.basemap.withLocation + +```jsonnet +options.basemap.withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Common method to define geometry fields +##### fn options.basemap.withLocationMixin + +```jsonnet +options.basemap.withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Common method to define geometry fields +##### fn options.basemap.withName + +```jsonnet +options.basemap.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +##### fn options.basemap.withOpacity + +```jsonnet +options.basemap.withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +##### fn options.basemap.withTooltip + +```jsonnet +options.basemap.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +##### fn options.basemap.withType + +```jsonnet +options.basemap.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### obj options.basemap.location + + +###### fn options.basemap.location.withGazetteer + +```jsonnet +options.basemap.location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +###### fn options.basemap.location.withGeohash + +```jsonnet +options.basemap.location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +###### fn options.basemap.location.withLatitude + +```jsonnet +options.basemap.location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLongitude + +```jsonnet +options.basemap.location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withLookup + +```jsonnet +options.basemap.location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn options.basemap.location.withMode + +```jsonnet +options.basemap.location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +###### fn options.basemap.location.withWkt + +```jsonnet +options.basemap.location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.controls + + +##### fn options.controls.withMouseWheelZoom + +```jsonnet +options.controls.withMouseWheelZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +let the mouse wheel zoom +##### fn options.controls.withShowAttribution + +```jsonnet +options.controls.withShowAttribution(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Lower right +##### fn options.controls.withShowDebug + +```jsonnet +options.controls.withShowDebug(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show debug +##### fn options.controls.withShowMeasure + +```jsonnet +options.controls.withShowMeasure(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Show measure +##### fn options.controls.withShowScale + +```jsonnet +options.controls.withShowScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Scale options +##### fn options.controls.withShowZoom + +```jsonnet +options.controls.withShowZoom(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Zoom (upper left) +#### obj options.tooltip + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"details"` + + +#### obj options.view + + +##### fn options.view.withAllLayers + +```jsonnet +options.view.withAllLayers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withId + +```jsonnet +options.view.withId(value="zero") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"zero"` + + +##### fn options.view.withLastOnly + +```jsonnet +options.view.withLastOnly(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withLat + +```jsonnet +options.view.withLat(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withLayer + +```jsonnet +options.view.withLayer(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.view.withLon + +```jsonnet +options.view.withLon(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +##### fn options.view.withMaxZoom + +```jsonnet +options.view.withMaxZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withMinZoom + +```jsonnet +options.view.withMinZoom(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withPadding + +```jsonnet +options.view.withPadding(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.view.withShared + +```jsonnet +options.view.withShared(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.view.withZoom + +```jsonnet +options.view.withZoom(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/options/layers.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/options/layers.md new file mode 100644 index 0000000..e6a1da9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/options/layers.md @@ -0,0 +1,220 @@ +# layers + + + +## Index + +* [`fn withConfig(value)`](#fn-withconfig) +* [`fn withConfigMixin(value)`](#fn-withconfigmixin) +* [`fn withFilterData(value)`](#fn-withfilterdata) +* [`fn withFilterDataMixin(value)`](#fn-withfilterdatamixin) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withLocationMixin(value)`](#fn-withlocationmixin) +* [`fn withName(value)`](#fn-withname) +* [`fn withOpacity(value)`](#fn-withopacity) +* [`fn withTooltip(value=true)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`obj location`](#obj-location) + * [`fn withGazetteer(value)`](#fn-locationwithgazetteer) + * [`fn withGeohash(value)`](#fn-locationwithgeohash) + * [`fn withLatitude(value)`](#fn-locationwithlatitude) + * [`fn withLongitude(value)`](#fn-locationwithlongitude) + * [`fn withLookup(value)`](#fn-locationwithlookup) + * [`fn withMode(value)`](#fn-locationwithmode) + * [`fn withWkt(value)`](#fn-locationwithwkt) + +## Fields + +### fn withConfig + +```jsonnet +withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withConfigMixin + +```jsonnet +withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Custom options depending on the type +### fn withFilterData + +```jsonnet +withFilterData(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withFilterDataMixin + +```jsonnet +withFilterDataMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Defines a frame MatcherConfig that may filter data for the given layer +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Common method to define geometry fields +### fn withLocationMixin + +```jsonnet +withLocationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Common method to define geometry fields +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +configured unique display name +### fn withOpacity + +```jsonnet +withOpacity(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Common properties: +https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html +Layer opacity (0-1) +### fn withTooltip + +```jsonnet +withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Check tooltip (defaults to true) +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj location + + +#### fn location.withGazetteer + +```jsonnet +location.withGazetteer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Path to Gazetteer +#### fn location.withGeohash + +```jsonnet +location.withGeohash(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field mappings +#### fn location.withLatitude + +```jsonnet +location.withLatitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLongitude + +```jsonnet +location.withLongitude(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withLookup + +```jsonnet +location.withLookup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn location.withMode + +```jsonnet +location.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"geohash"`, `"coords"`, `"lookup"` + + +#### fn location.withWkt + +```jsonnet +location.withWkt(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/geomap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/index.md new file mode 100644 index 0000000..46fba20 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/index.md @@ -0,0 +1,1864 @@ +# heatmap + +grafonnet.panel.heatmap + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCalculate(value=true)`](#fn-optionswithcalculate) + * [`fn withCalculation(value)`](#fn-optionswithcalculation) + * [`fn withCalculationMixin(value)`](#fn-optionswithcalculationmixin) + * [`fn withCellGap(value=1)`](#fn-optionswithcellgap) + * [`fn withCellRadius(value)`](#fn-optionswithcellradius) + * [`fn withCellValues(value)`](#fn-optionswithcellvalues) + * [`fn withCellValuesMixin(value)`](#fn-optionswithcellvaluesmixin) + * [`fn withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolor) + * [`fn withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64})`](#fn-optionswithcolormixin) + * [`fn withExemplars(value={"color": "rgba(255,0,255,0.7)"})`](#fn-optionswithexemplars) + * [`fn withExemplarsMixin(value={"color": "rgba(255,0,255,0.7)"})`](#fn-optionswithexemplarsmixin) + * [`fn withFilterValues(value={"le": 0.000000001})`](#fn-optionswithfiltervalues) + * [`fn withFilterValuesMixin(value={"le": 0.000000001})`](#fn-optionswithfiltervaluesmixin) + * [`fn withLegend(value={"show": true})`](#fn-optionswithlegend) + * [`fn withLegendMixin(value={"show": true})`](#fn-optionswithlegendmixin) + * [`fn withRowsFrame(value)`](#fn-optionswithrowsframe) + * [`fn withRowsFrameMixin(value)`](#fn-optionswithrowsframemixin) + * [`fn withSelectionMode(value="x")`](#fn-optionswithselectionmode) + * [`fn withShowValue(value="auto")`](#fn-optionswithshowvalue) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withYAxis(value)`](#fn-optionswithyaxis) + * [`fn withYAxisMixin(value)`](#fn-optionswithyaxismixin) + * [`obj calculation`](#obj-optionscalculation) + * [`fn withXBuckets(value)`](#fn-optionscalculationwithxbuckets) + * [`fn withXBucketsMixin(value)`](#fn-optionscalculationwithxbucketsmixin) + * [`fn withYBuckets(value)`](#fn-optionscalculationwithybuckets) + * [`fn withYBucketsMixin(value)`](#fn-optionscalculationwithybucketsmixin) + * [`obj xBuckets`](#obj-optionscalculationxbuckets) + * [`fn withMode(value)`](#fn-optionscalculationxbucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationxbucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationxbucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationxbucketswithvalue) + * [`obj scale`](#obj-optionscalculationxbucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationxbucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationxbucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationxbucketsscalewithtype) + * [`obj yBuckets`](#obj-optionscalculationybuckets) + * [`fn withMode(value)`](#fn-optionscalculationybucketswithmode) + * [`fn withScale(value)`](#fn-optionscalculationybucketswithscale) + * [`fn withScaleMixin(value)`](#fn-optionscalculationybucketswithscalemixin) + * [`fn withValue(value)`](#fn-optionscalculationybucketswithvalue) + * [`obj scale`](#obj-optionscalculationybucketsscale) + * [`fn withLinearThreshold(value)`](#fn-optionscalculationybucketsscalewithlinearthreshold) + * [`fn withLog(value)`](#fn-optionscalculationybucketsscalewithlog) + * [`fn withType(value)`](#fn-optionscalculationybucketsscalewithtype) + * [`obj cellValues`](#obj-optionscellvalues) + * [`fn withDecimals(value)`](#fn-optionscellvalueswithdecimals) + * [`fn withUnit(value)`](#fn-optionscellvalueswithunit) + * [`obj color`](#obj-optionscolor) + * [`fn withExponent(value)`](#fn-optionscolorwithexponent) + * [`fn withFill(value)`](#fn-optionscolorwithfill) + * [`fn withMax(value)`](#fn-optionscolorwithmax) + * [`fn withMin(value)`](#fn-optionscolorwithmin) + * [`fn withMode(value)`](#fn-optionscolorwithmode) + * [`fn withReverse(value=true)`](#fn-optionscolorwithreverse) + * [`fn withScale(value)`](#fn-optionscolorwithscale) + * [`fn withScheme(value)`](#fn-optionscolorwithscheme) + * [`fn withSteps(value)`](#fn-optionscolorwithsteps) + * [`obj exemplars`](#obj-optionsexemplars) + * [`fn withColor(value)`](#fn-optionsexemplarswithcolor) + * [`obj filterValues`](#obj-optionsfiltervalues) + * [`fn withGe(value)`](#fn-optionsfiltervalueswithge) + * [`fn withLe(value)`](#fn-optionsfiltervalueswithle) + * [`obj legend`](#obj-optionslegend) + * [`fn withShow(value=true)`](#fn-optionslegendwithshow) + * [`obj rowsFrame`](#obj-optionsrowsframe) + * [`fn withLayout(value)`](#fn-optionsrowsframewithlayout) + * [`fn withValue(value)`](#fn-optionsrowsframewithvalue) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withShowColorScale(value=true)`](#fn-optionstooltipwithshowcolorscale) + * [`fn withYHistogram(value=true)`](#fn-optionstooltipwithyhistogram) + * [`obj yAxis`](#obj-optionsyaxis) + * [`fn withAxisBorderShow(value=true)`](#fn-optionsyaxiswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-optionsyaxiswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-optionsyaxiswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-optionsyaxiswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-optionsyaxiswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-optionsyaxiswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-optionsyaxiswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-optionsyaxiswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-optionsyaxiswithaxiswidth) + * [`fn withDecimals(value)`](#fn-optionsyaxiswithdecimals) + * [`fn withMax(value)`](#fn-optionsyaxiswithmax) + * [`fn withMin(value)`](#fn-optionsyaxiswithmin) + * [`fn withReverse(value=true)`](#fn-optionsyaxiswithreverse) + * [`fn withScaleDistribution(value)`](#fn-optionsyaxiswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-optionsyaxiswithscaledistributionmixin) + * [`fn withUnit(value)`](#fn-optionsyaxiswithunit) + * [`obj scaleDistribution`](#obj-optionsyaxisscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-optionsyaxisscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-optionsyaxisscaledistributionwithlog) + * [`fn withType(value)`](#fn-optionsyaxisscaledistributionwithtype) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new heatmap panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCalculate + +```jsonnet +options.withCalculate(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the heatmap should be calculated from data +#### fn options.withCalculation + +```jsonnet +options.withCalculation(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Calculation options for the heatmap +#### fn options.withCalculationMixin + +```jsonnet +options.withCalculationMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Calculation options for the heatmap +#### fn options.withCellGap + +```jsonnet +options.withCellGap(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls gap between cells +#### fn options.withCellRadius + +```jsonnet +options.withCellRadius(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls cell radius +#### fn options.withCellValues + +```jsonnet +options.withCellValues(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withCellValuesMixin + +```jsonnet +options.withCellValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls cell value options +#### fn options.withColor + +```jsonnet +options.withColor(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` + +Controls various color options +#### fn options.withColorMixin + +```jsonnet +options.withColorMixin(value={"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"exponent": 0.5,"fill": "dark-orange","reverse": false,"scheme": "Oranges","steps": 64}` + +Controls various color options +#### fn options.withExemplars + +```jsonnet +options.withExemplars(value={"color": "rgba(255,0,255,0.7)"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"color": "rgba(255,0,255,0.7)"}` + +Controls exemplar options +#### fn options.withExemplarsMixin + +```jsonnet +options.withExemplarsMixin(value={"color": "rgba(255,0,255,0.7)"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"color": "rgba(255,0,255,0.7)"}` + +Controls exemplar options +#### fn options.withFilterValues + +```jsonnet +options.withFilterValues(value={"le": 0.000000001}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"le": 0.000000001}` + +Controls the value filter range +#### fn options.withFilterValuesMixin + +```jsonnet +options.withFilterValuesMixin(value={"le": 0.000000001}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"le": 0.000000001}` + +Controls the value filter range +#### fn options.withLegend + +```jsonnet +options.withLegend(value={"show": true}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"show": true}` + +Controls legend options +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value={"show": true}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"show": true}` + +Controls legend options +#### fn options.withRowsFrame + +```jsonnet +options.withRowsFrame(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withRowsFrameMixin + +```jsonnet +options.withRowsFrameMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls frame rows options +#### fn options.withSelectionMode + +```jsonnet +options.withSelectionMode(value="x") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"x"` + - valid values: `"x"`, `"y"`, `"xy"` + +Controls which axis to allow selection on +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Controls tooltip options +#### fn options.withYAxis + +```jsonnet +options.withYAxis(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### fn options.withYAxisMixin + +```jsonnet +options.withYAxisMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration options for the yAxis +#### obj options.calculation + + +##### fn options.calculation.withXBuckets + +```jsonnet +options.calculation.withXBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The number of buckets to use for the xAxis in the heatmap +##### fn options.calculation.withXBucketsMixin + +```jsonnet +options.calculation.withXBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The number of buckets to use for the xAxis in the heatmap +##### fn options.calculation.withYBuckets + +```jsonnet +options.calculation.withYBuckets(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The number of buckets to use for the yAxis in the heatmap +##### fn options.calculation.withYBucketsMixin + +```jsonnet +options.calculation.withYBucketsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The number of buckets to use for the yAxis in the heatmap +##### obj options.calculation.xBuckets + + +###### fn options.calculation.xBuckets.withMode + +```jsonnet +options.calculation.xBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + +Sets the bucket calculation mode +###### fn options.calculation.xBuckets.withScale + +```jsonnet +options.calculation.xBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withScaleMixin + +```jsonnet +options.calculation.xBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.xBuckets.withValue + +```jsonnet +options.calculation.xBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.xBuckets.scale + + +####### fn options.calculation.xBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.xBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withLog + +```jsonnet +options.calculation.xBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.xBuckets.scale.withType + +```jsonnet +options.calculation.xBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +##### obj options.calculation.yBuckets + + +###### fn options.calculation.yBuckets.withMode + +```jsonnet +options.calculation.yBuckets.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"size"`, `"count"` + +Sets the bucket calculation mode +###### fn options.calculation.yBuckets.withScale + +```jsonnet +options.calculation.yBuckets.withScale(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withScaleMixin + +```jsonnet +options.calculation.yBuckets.withScaleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn options.calculation.yBuckets.withValue + +```jsonnet +options.calculation.yBuckets.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The number of buckets to use for the axis in the heatmap +###### obj options.calculation.yBuckets.scale + + +####### fn options.calculation.yBuckets.scale.withLinearThreshold + +```jsonnet +options.calculation.yBuckets.scale.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withLog + +```jsonnet +options.calculation.yBuckets.scale.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn options.calculation.yBuckets.scale.withType + +```jsonnet +options.calculation.yBuckets.scale.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +#### obj options.cellValues + + +##### fn options.cellValues.withDecimals + +```jsonnet +options.cellValues.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for cell values +##### fn options.cellValues.withUnit + +```jsonnet +options.cellValues.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the cell value unit +#### obj options.color + + +##### fn options.color.withExponent + +```jsonnet +options.color.withExponent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the exponent when scale is set to exponential +##### fn options.color.withFill + +```jsonnet +options.color.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color fill when in opacity mode +##### fn options.color.withMax + +```jsonnet +options.color.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the color scale +##### fn options.color.withMin + +```jsonnet +options.color.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the color scale +##### fn options.color.withMode + +```jsonnet +options.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"opacity"`, `"scheme"` + +Controls the color mode of the heatmap +##### fn options.color.withReverse + +```jsonnet +options.color.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the color scheme +##### fn options.color.withScale + +```jsonnet +options.color.withScale(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"exponential"` + +Controls the color scale of the heatmap +##### fn options.color.withScheme + +```jsonnet +options.color.withScheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Controls the color scheme used +##### fn options.color.withSteps + +```jsonnet +options.color.withSteps(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Controls the number of color steps +#### obj options.exemplars + + +##### fn options.exemplars.withColor + +```jsonnet +options.exemplars.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the color of the exemplar markers +#### obj options.filterValues + + +##### fn options.filterValues.withGe + +```jsonnet +options.filterValues.withGe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values greater than or equal to the given value +##### fn options.filterValues.withLe + +```jsonnet +options.filterValues.withLe(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the filter range to values less than or equal to the given value +#### obj options.legend + + +##### fn options.legend.withShow + +```jsonnet +options.legend.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the legend is shown +#### obj options.rowsFrame + + +##### fn options.rowsFrame.withLayout + +```jsonnet +options.rowsFrame.withLayout(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"le"`, `"ge"`, `"unknown"`, `"auto"` + +Controls tick alignment when not calculating from data +##### fn options.rowsFrame.withValue + +```jsonnet +options.rowsFrame.withValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the name of the cell when not calculating from data +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withShowColorScale + +```jsonnet +options.tooltip.withShowColorScale(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a color scale in header +##### fn options.tooltip.withYHistogram + +```jsonnet +options.tooltip.withYHistogram(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the tooltip shows a histogram of the y-axis values +#### obj options.yAxis + + +##### fn options.yAxis.withAxisBorderShow + +```jsonnet +options.yAxis.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisCenteredZero + +```jsonnet +options.yAxis.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisColorMode + +```jsonnet +options.yAxis.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +##### fn options.yAxis.withAxisGridShow + +```jsonnet +options.yAxis.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.yAxis.withAxisLabel + +```jsonnet +options.yAxis.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.yAxis.withAxisPlacement + +```jsonnet +options.yAxis.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +##### fn options.yAxis.withAxisSoftMax + +```jsonnet +options.yAxis.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisSoftMin + +```jsonnet +options.yAxis.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withAxisWidth + +```jsonnet +options.yAxis.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.yAxis.withDecimals + +```jsonnet +options.yAxis.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Controls the number of decimals for yAxis values +##### fn options.yAxis.withMax + +```jsonnet +options.yAxis.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the maximum value for the yAxis +##### fn options.yAxis.withMin + +```jsonnet +options.yAxis.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Sets the minimum value for the yAxis +##### fn options.yAxis.withReverse + +```jsonnet +options.yAxis.withReverse(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Reverses the yAxis +##### fn options.yAxis.withScaleDistribution + +```jsonnet +options.yAxis.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withScaleDistributionMixin + +```jsonnet +options.yAxis.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +##### fn options.yAxis.withUnit + +```jsonnet +options.yAxis.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the yAxis unit +##### obj options.yAxis.scaleDistribution + + +###### fn options.yAxis.scaleDistribution.withLinearThreshold + +```jsonnet +options.yAxis.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withLog + +```jsonnet +options.yAxis.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn options.yAxis.scaleDistribution.withType + +```jsonnet +options.yAxis.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/heatmap/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/index.md new file mode 100644 index 0000000..3e0c63f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/index.md @@ -0,0 +1,1285 @@ +# histogram + +grafonnet.panel.histogram + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withFillOpacity(value=80)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value="none")`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withBucketCount(value=30)`](#fn-optionswithbucketcount) + * [`fn withBucketOffset(value=0)`](#fn-optionswithbucketoffset) + * [`fn withBucketSize(value)`](#fn-optionswithbucketsize) + * [`fn withCombine(value=true)`](#fn-optionswithcombine) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new histogram panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=80) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `80` + +Controls the fill opacity of the bars. +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value="none") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"none"` + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + +Controls line width of the bars. +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withBucketCount + +```jsonnet +options.withBucketCount(value=30) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `30` + +Bucket count (approx) +#### fn options.withBucketOffset + +```jsonnet +options.withBucketOffset(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Offset buckets by this amount +#### fn options.withBucketSize + +```jsonnet +options.withBucketSize(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Size of each bucket +#### fn options.withCombine + +```jsonnet +options.withCombine(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Combines multiple series into a single histogram +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/histogram/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/index.md new file mode 100644 index 0000000..3111a61 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/index.md @@ -0,0 +1,32 @@ +# panel + +grafonnet.panel + +## Subpackages + +* [alertList](alertList/index.md) +* [annotationsList](annotationsList/index.md) +* [barChart](barChart/index.md) +* [barGauge](barGauge/index.md) +* [candlestick](candlestick/index.md) +* [canvas](canvas/index.md) +* [dashboardList](dashboardList/index.md) +* [datagrid](datagrid/index.md) +* [debug](debug/index.md) +* [gauge](gauge/index.md) +* [geomap](geomap/index.md) +* [heatmap](heatmap/index.md) +* [histogram](histogram/index.md) +* [logs](logs/index.md) +* [news](news/index.md) +* [nodeGraph](nodeGraph/index.md) +* [pieChart](pieChart/index.md) +* [row](row.md) +* [stat](stat/index.md) +* [stateTimeline](stateTimeline/index.md) +* [statusHistory](statusHistory/index.md) +* [table](table/index.md) +* [text](text/index.md) +* [timeSeries](timeSeries/index.md) +* [trend](trend/index.md) +* [xyChart](xyChart/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/index.md new file mode 100644 index 0000000..92d3d9f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/index.md @@ -0,0 +1,956 @@ +# logs + +grafonnet.panel.logs + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDedupStrategy(value)`](#fn-optionswithdedupstrategy) + * [`fn withDisplayedFields(value)`](#fn-optionswithdisplayedfields) + * [`fn withDisplayedFieldsMixin(value)`](#fn-optionswithdisplayedfieldsmixin) + * [`fn withEnableLogDetails(value=true)`](#fn-optionswithenablelogdetails) + * [`fn withIsFilterLabelActive(value)`](#fn-optionswithisfilterlabelactive) + * [`fn withIsFilterLabelActiveMixin(value)`](#fn-optionswithisfilterlabelactivemixin) + * [`fn withOnClickFilterLabel(value)`](#fn-optionswithonclickfilterlabel) + * [`fn withOnClickFilterLabelMixin(value)`](#fn-optionswithonclickfilterlabelmixin) + * [`fn withOnClickFilterOutLabel(value)`](#fn-optionswithonclickfilteroutlabel) + * [`fn withOnClickFilterOutLabelMixin(value)`](#fn-optionswithonclickfilteroutlabelmixin) + * [`fn withOnClickFilterOutString(value)`](#fn-optionswithonclickfilteroutstring) + * [`fn withOnClickFilterOutStringMixin(value)`](#fn-optionswithonclickfilteroutstringmixin) + * [`fn withOnClickFilterString(value)`](#fn-optionswithonclickfilterstring) + * [`fn withOnClickFilterStringMixin(value)`](#fn-optionswithonclickfilterstringmixin) + * [`fn withOnClickHideField(value)`](#fn-optionswithonclickhidefield) + * [`fn withOnClickHideFieldMixin(value)`](#fn-optionswithonclickhidefieldmixin) + * [`fn withOnClickShowField(value)`](#fn-optionswithonclickshowfield) + * [`fn withOnClickShowFieldMixin(value)`](#fn-optionswithonclickshowfieldmixin) + * [`fn withPrettifyLogMessage(value=true)`](#fn-optionswithprettifylogmessage) + * [`fn withShowCommonLabels(value=true)`](#fn-optionswithshowcommonlabels) + * [`fn withShowLabels(value=true)`](#fn-optionswithshowlabels) + * [`fn withShowLogContextToggle(value=true)`](#fn-optionswithshowlogcontexttoggle) + * [`fn withShowTime(value=true)`](#fn-optionswithshowtime) + * [`fn withSortOrder(value)`](#fn-optionswithsortorder) + * [`fn withWrapLogMessage(value=true)`](#fn-optionswithwraplogmessage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new logs panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDedupStrategy + +```jsonnet +options.withDedupStrategy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"exact"`, `"numbers"`, `"signature"` + + +#### fn options.withDisplayedFields + +```jsonnet +options.withDisplayedFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withDisplayedFieldsMixin + +```jsonnet +options.withDisplayedFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withEnableLogDetails + +```jsonnet +options.withEnableLogDetails(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withIsFilterLabelActive + +```jsonnet +options.withIsFilterLabelActive(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withIsFilterLabelActiveMixin + +```jsonnet +options.withIsFilterLabelActiveMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterLabel + +```jsonnet +options.withOnClickFilterLabel(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define callbacks +#### fn options.withOnClickFilterLabelMixin + +```jsonnet +options.withOnClickFilterLabelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO: figure out how to define callbacks +#### fn options.withOnClickFilterOutLabel + +```jsonnet +options.withOnClickFilterOutLabel(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterOutLabelMixin + +```jsonnet +options.withOnClickFilterOutLabelMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterOutString + +```jsonnet +options.withOnClickFilterOutString(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterOutStringMixin + +```jsonnet +options.withOnClickFilterOutStringMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterString + +```jsonnet +options.withOnClickFilterString(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickFilterStringMixin + +```jsonnet +options.withOnClickFilterStringMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickHideField + +```jsonnet +options.withOnClickHideField(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickHideFieldMixin + +```jsonnet +options.withOnClickHideFieldMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickShowField + +```jsonnet +options.withOnClickShowField(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOnClickShowFieldMixin + +```jsonnet +options.withOnClickShowFieldMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withPrettifyLogMessage + +```jsonnet +options.withPrettifyLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowCommonLabels + +```jsonnet +options.withShowCommonLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLabels + +```jsonnet +options.withShowLabels(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowLogContextToggle + +```jsonnet +options.withShowLogContextToggle(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withShowTime + +```jsonnet +options.withShowTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withSortOrder + +```jsonnet +options.withSortOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Descending"`, `"Ascending"` + + +#### fn options.withWrapLogMessage + +```jsonnet +options.withWrapLogMessage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/logs/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/index.md new file mode 100644 index 0000000..2cc7b47 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/index.md @@ -0,0 +1,672 @@ +# news + +grafonnet.panel.news + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withFeedUrl(value)`](#fn-optionswithfeedurl) + * [`fn withShowImage(value=true)`](#fn-optionswithshowimage) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new news panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withFeedUrl + +```jsonnet +options.withFeedUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +empty/missing will default to grafana blog +#### fn options.withShowImage + +```jsonnet +options.withShowImage(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/news/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/index.md new file mode 100644 index 0000000..96e1eb6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/index.md @@ -0,0 +1,776 @@ +# nodeGraph + +grafonnet.panel.nodeGraph + +## Subpackages + +* [options.nodes.arcs](options/nodes/arcs.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withEdges(value)`](#fn-optionswithedges) + * [`fn withEdgesMixin(value)`](#fn-optionswithedgesmixin) + * [`fn withNodes(value)`](#fn-optionswithnodes) + * [`fn withNodesMixin(value)`](#fn-optionswithnodesmixin) + * [`obj edges`](#obj-optionsedges) + * [`fn withMainStatUnit(value)`](#fn-optionsedgeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsedgeswithsecondarystatunit) + * [`obj nodes`](#obj-optionsnodes) + * [`fn withArcs(value)`](#fn-optionsnodeswitharcs) + * [`fn withArcsMixin(value)`](#fn-optionsnodeswitharcsmixin) + * [`fn withMainStatUnit(value)`](#fn-optionsnodeswithmainstatunit) + * [`fn withSecondaryStatUnit(value)`](#fn-optionsnodeswithsecondarystatunit) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new nodeGraph panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withEdges + +```jsonnet +options.withEdges(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withEdgesMixin + +```jsonnet +options.withEdgesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodes + +```jsonnet +options.withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withNodesMixin + +```jsonnet +options.withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj options.edges + + +##### fn options.edges.withMainStatUnit + +```jsonnet +options.edges.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.edges.withSecondaryStatUnit + +```jsonnet +options.edges.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +#### obj options.nodes + + +##### fn options.nodes.withArcs + +```jsonnet +options.nodes.withArcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withArcsMixin + +```jsonnet +options.nodes.withArcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Define which fields are shown as part of the node arc (colored circle around the node). +##### fn options.nodes.withMainStatUnit + +```jsonnet +options.nodes.withMainStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the main stat to override what ever is set in the data frame. +##### fn options.nodes.withSecondaryStatUnit + +```jsonnet +options.nodes.withSecondaryStatUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit for the secondary stat to override what ever is set in the data frame. +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/options/nodes/arcs.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/options/nodes/arcs.md new file mode 100644 index 0000000..f80fe24 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/options/nodes/arcs.md @@ -0,0 +1,33 @@ +# arcs + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withField(value)`](#fn-withfield) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The color of the arc. +### fn withField + +```jsonnet +withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Field from which to get the value. Values should be less than 1, representing fraction of a circle. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/nodeGraph/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/index.md new file mode 100644 index 0000000..65d414c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/index.md @@ -0,0 +1,1174 @@ +# pieChart + +grafonnet.panel.pieChart + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDisplayLabels(value)`](#fn-optionswithdisplaylabels) + * [`fn withDisplayLabelsMixin(value)`](#fn-optionswithdisplaylabelsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withPieType(value)`](#fn-optionswithpietype) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value)`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value)`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value)`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withValues(value)`](#fn-optionslegendwithvalues) + * [`fn withValuesMixin(value)`](#fn-optionslegendwithvaluesmixin) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new pieChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDisplayLabels + +```jsonnet +options.withDisplayLabels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withDisplayLabelsMixin + +```jsonnet +options.withDisplayLabelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withPieType + +```jsonnet +options.withPieType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pie"`, `"donut"` + +Select the pie chart display style. +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withValues + +```jsonnet +options.legend.withValues(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withValuesMixin + +```jsonnet +options.legend.withValuesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/pieChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/row.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/row.md new file mode 100644 index 0000000..0541b04 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/row.md @@ -0,0 +1,179 @@ +# row + +grafonnet.panel.row + +## Index + +* [`fn new(title)`](#fn-new) +* [`fn withCollapsed(value=true)`](#fn-withcollapsed) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withGridPos(y)`](#fn-withgridpos) +* [`fn withGridPosMixin(value)`](#fn-withgridposmixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withPanels(value)`](#fn-withpanels) +* [`fn withPanelsMixin(value)`](#fn-withpanelsmixin) +* [`fn withRepeat(value)`](#fn-withrepeat) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new row panel with a title. +### fn withCollapsed + +```jsonnet +withCollapsed(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether this row should be collapsed or not. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withGridPos + +```jsonnet +withGridPos(y) +``` + +PARAMETERS: + +* **y** (`number`) + +`withGridPos` sets the Y-axis on a row panel. x, width and height are fixed values. +### fn withGridPosMixin + +```jsonnet +withGridPosMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Position and dimensions of a panel in the grid +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally. +### fn withPanels + +```jsonnet +withPanels(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPanelsMixin + +```jsonnet +withPanelsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withRepeat + +```jsonnet +withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Row title +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/index.md new file mode 100644 index 0000000..045e49f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/index.md @@ -0,0 +1,897 @@ +# stat + +grafonnet.panel.stat + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColorMode(value="value")`](#fn-optionswithcolormode) + * [`fn withGraphMode(value="area")`](#fn-optionswithgraphmode) + * [`fn withJustifyMode(value="auto")`](#fn-optionswithjustifymode) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withPercentChangeColorMode(value="standard")`](#fn-optionswithpercentchangecolormode) + * [`fn withReduceOptions(value)`](#fn-optionswithreduceoptions) + * [`fn withReduceOptionsMixin(value)`](#fn-optionswithreduceoptionsmixin) + * [`fn withShowPercentChange(value=true)`](#fn-optionswithshowpercentchange) + * [`fn withText(value)`](#fn-optionswithtext) + * [`fn withTextMixin(value)`](#fn-optionswithtextmixin) + * [`fn withTextMode(value="auto")`](#fn-optionswithtextmode) + * [`fn withWideLayout(value=true)`](#fn-optionswithwidelayout) + * [`obj reduceOptions`](#obj-optionsreduceoptions) + * [`fn withCalcs(value)`](#fn-optionsreduceoptionswithcalcs) + * [`fn withCalcsMixin(value)`](#fn-optionsreduceoptionswithcalcsmixin) + * [`fn withFields(value)`](#fn-optionsreduceoptionswithfields) + * [`fn withLimit(value)`](#fn-optionsreduceoptionswithlimit) + * [`fn withValues(value=true)`](#fn-optionsreduceoptionswithvalues) + * [`obj text`](#obj-optionstext) + * [`fn withTitleSize(value)`](#fn-optionstextwithtitlesize) + * [`fn withValueSize(value)`](#fn-optionstextwithvaluesize) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stat panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColorMode + +```jsonnet +options.withColorMode(value="value") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"value"` + - valid values: `"value"`, `"background"`, `"background_solid"`, `"none"` + +TODO docs +#### fn options.withGraphMode + +```jsonnet +options.withGraphMode(value="area") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"area"` + - valid values: `"none"`, `"line"`, `"area"` + +TODO docs +#### fn options.withJustifyMode + +```jsonnet +options.withJustifyMode(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"center"` + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withPercentChangeColorMode + +```jsonnet +options.withPercentChangeColorMode(value="standard") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"standard"` + - valid values: `"standard"`, `"inverted"`, `"same_as_value"` + +TODO docs +#### fn options.withReduceOptions + +```jsonnet +options.withReduceOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withReduceOptionsMixin + +```jsonnet +options.withReduceOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withShowPercentChange + +```jsonnet +options.withShowPercentChange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn options.withText + +```jsonnet +options.withText(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMixin + +```jsonnet +options.withTextMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTextMode + +```jsonnet +options.withTextMode(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"value"`, `"value_and_name"`, `"name"`, `"none"` + +TODO docs +#### fn options.withWideLayout + +```jsonnet +options.withWideLayout(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj options.reduceOptions + + +##### fn options.reduceOptions.withCalcs + +```jsonnet +options.reduceOptions.withCalcs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withCalcsMixin + +```jsonnet +options.reduceOptions.withCalcsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +When !values, pick one value for the whole field +##### fn options.reduceOptions.withFields + +```jsonnet +options.reduceOptions.withFields(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Which fields to show. By default this is only numeric fields +##### fn options.reduceOptions.withLimit + +```jsonnet +options.reduceOptions.withLimit(value) +``` + +PARAMETERS: + +* **value** (`number`) + +if showing all values limit +##### fn options.reduceOptions.withValues + +```jsonnet +options.reduceOptions.withValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true show each row value +#### obj options.text + + +##### fn options.text.withTitleSize + +```jsonnet +options.text.withTitleSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit title text size +##### fn options.text.withValueSize + +```jsonnet +options.text.withValueSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Explicit value text size +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stat/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/index.md new file mode 100644 index 0000000..7eb5038 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/index.md @@ -0,0 +1,1080 @@ +# stateTimeline + +grafonnet.panel.stateTimeline + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=0)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withAlignValue(value="left")`](#fn-optionswithalignvalue) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withMergeValues(value=true)`](#fn-optionswithmergevalues) + * [`fn withPerPage(value=20)`](#fn-optionswithperpage) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value="auto")`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new stateTimeline panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=0) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `0` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withAlignValue + +```jsonnet +options.withAlignValue(value="left") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"left"` + - valid values: `"center"`, `"left"`, `"right"` + +Controls the value alignment in the TimelineChart component +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withMergeValues + +```jsonnet +options.withMergeValues(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Merge equal consecutive values +#### fn options.withPerPage + +```jsonnet +options.withPerPage(value=20) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `20` + +Enables pagination when > 0 +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the row height +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/stateTimeline/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/index.md new file mode 100644 index 0000000..c790ce3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/index.md @@ -0,0 +1,1053 @@ +# statusHistory + +grafonnet.panel.statusHistory + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withFillOpacity(value=70)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLineWidth(value=1)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withColWidth(value=0.9)`](#fn-optionswithcolwidth) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withRowHeight(value=0.9)`](#fn-optionswithrowheight) + * [`fn withShowValue(value="auto")`](#fn-optionswithshowvalue) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new statusHistory panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value=70) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `70` + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value=1) +``` + +PARAMETERS: + +* **value** (`integer`) + - default value: `1` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withColWidth + +```jsonnet +options.withColWidth(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Controls the column width +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withRowHeight + +```jsonnet +options.withRowHeight(value=0.9) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0.9` + +Set the height of the rows +#### fn options.withShowValue + +```jsonnet +options.withShowValue(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/statusHistory/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/index.md new file mode 100644 index 0000000..79470c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/index.md @@ -0,0 +1,2072 @@ +# table + +grafonnet.panel.table + +## Subpackages + +* [options.sortBy](options/sortBy.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAlign(value="auto")`](#fn-fieldconfigdefaultscustomwithalign) + * [`fn withCellOptions(value)`](#fn-fieldconfigdefaultscustomwithcelloptions) + * [`fn withCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomwithcelloptionsmixin) + * [`fn withDisplayMode(value)`](#fn-fieldconfigdefaultscustomwithdisplaymode) + * [`fn withFilterable(value=true)`](#fn-fieldconfigdefaultscustomwithfilterable) + * [`fn withHidden(value=true)`](#fn-fieldconfigdefaultscustomwithhidden) + * [`fn withHideHeader(value=true)`](#fn-fieldconfigdefaultscustomwithhideheader) + * [`fn withInspect(value=true)`](#fn-fieldconfigdefaultscustomwithinspect) + * [`fn withMinWidth(value)`](#fn-fieldconfigdefaultscustomwithminwidth) + * [`fn withWidth(value)`](#fn-fieldconfigdefaultscustomwithwidth) + * [`obj cellOptions`](#obj-fieldconfigdefaultscustomcelloptions) + * [`fn withTableAutoCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptions) + * [`fn withTableAutoCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableautocelloptionsmixin) + * [`fn withTableBarGaugeCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptions) + * [`fn withTableBarGaugeCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablebargaugecelloptionsmixin) + * [`fn withTableColorTextCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptions) + * [`fn withTableColorTextCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecolortextcelloptionsmixin) + * [`fn withTableColoredBackgroundCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptions) + * [`fn withTableColoredBackgroundCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablecoloredbackgroundcelloptionsmixin) + * [`fn withTableDataLinksCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptions) + * [`fn withTableDataLinksCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtabledatalinkscelloptionsmixin) + * [`fn withTableImageCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptions) + * [`fn withTableImageCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtableimagecelloptionsmixin) + * [`fn withTableJsonViewCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptions) + * [`fn withTableJsonViewCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablejsonviewcelloptionsmixin) + * [`fn withTableSparklineCellOptions(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptions) + * [`fn withTableSparklineCellOptionsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionswithtablesparklinecelloptionsmixin) + * [`obj TableAutoCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableautocelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithtype) + * [`fn withWrapText(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstableautocelloptionswithwraptext) + * [`obj TableBarGaugeCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablebargaugecelloptions) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithtype) + * [`fn withValueDisplayMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablebargaugecelloptionswithvaluedisplaymode) + * [`obj TableColorTextCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecolortextcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithtype) + * [`fn withWrapText(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecolortextcelloptionswithwraptext) + * [`obj TableColoredBackgroundCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptions) + * [`fn withApplyToRow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithapplytorow) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithmode) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithtype) + * [`fn withWrapText(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablecoloredbackgroundcelloptionswithwraptext) + * [`obj TableDataLinksCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstabledatalinkscelloptionswithtype) + * [`obj TableImageCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstableimagecelloptions) + * [`fn withAlt(value)`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithalt) + * [`fn withTitle(value)`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtitle) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstableimagecelloptionswithtype) + * [`obj TableJsonViewCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptions) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablejsonviewcelloptionswithtype) + * [`obj TableSparklineCellOptions`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptions) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidefrommixin) + * [`fn withHideValue(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithhidevalue) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtransform) + * [`fn withType()`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionswithtype) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionshidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionslinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomcelloptionstablesparklinecelloptionsthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCellHeight(value="sm")`](#fn-optionswithcellheight) + * [`fn withFooter(value={"countRows": false,"reducer": null,"show": false})`](#fn-optionswithfooter) + * [`fn withFooterMixin(value={"countRows": false,"reducer": null,"show": false})`](#fn-optionswithfootermixin) + * [`fn withFrameIndex(value=0)`](#fn-optionswithframeindex) + * [`fn withShowHeader(value=true)`](#fn-optionswithshowheader) + * [`fn withShowTypeIcons(value=true)`](#fn-optionswithshowtypeicons) + * [`fn withSortBy(value)`](#fn-optionswithsortby) + * [`fn withSortByMixin(value)`](#fn-optionswithsortbymixin) + * [`obj footer`](#obj-optionsfooter) + * [`fn withCountRows(value=true)`](#fn-optionsfooterwithcountrows) + * [`fn withEnablePagination(value=true)`](#fn-optionsfooterwithenablepagination) + * [`fn withFields(value)`](#fn-optionsfooterwithfields) + * [`fn withFieldsMixin(value)`](#fn-optionsfooterwithfieldsmixin) + * [`fn withReducer(value)`](#fn-optionsfooterwithreducer) + * [`fn withReducerMixin(value)`](#fn-optionsfooterwithreducermixin) + * [`fn withShow(value=true)`](#fn-optionsfooterwithshow) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new table panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAlign + +```jsonnet +fieldConfig.defaults.custom.withAlign(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"left"`, `"right"`, `"center"` + +TODO -- should not be table specific! +TODO docs +###### fn fieldConfig.defaults.custom.withCellOptions + +```jsonnet +fieldConfig.defaults.custom.withCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.withCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Table cell options. Each cell has a display mode +and other potential options for that display. +###### fn fieldConfig.defaults.custom.withDisplayMode + +```jsonnet +fieldConfig.defaults.custom.withDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"color-text"`, `"color-background"`, `"color-background-solid"`, `"gradient-gauge"`, `"lcd-gauge"`, `"json-view"`, `"basic"`, `"image"`, `"gauge"`, `"sparkline"`, `"data-links"`, `"custom"` + +Internally, this is the "type" of cell that's being displayed +in the table such as colored text, JSON, gauge, etc. +The color-background-solid, gradient-gauge, and lcd-gauge +modes are deprecated in favor of new cell subOptions +###### fn fieldConfig.defaults.custom.withFilterable + +```jsonnet +fieldConfig.defaults.custom.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withHidden + +```jsonnet +fieldConfig.defaults.custom.withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +?? default is missing or false ?? +###### fn fieldConfig.defaults.custom.withHideHeader + +```jsonnet +fieldConfig.defaults.custom.withHideHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Hides any header for a column, useful for columns that show some static content or buttons. +###### fn fieldConfig.defaults.custom.withInspect + +```jsonnet +fieldConfig.defaults.custom.withInspect(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withMinWidth + +```jsonnet +fieldConfig.defaults.custom.withMinWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withWidth + +```jsonnet +fieldConfig.defaults.custom.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### obj fieldConfig.defaults.custom.cellOptions + + +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Auto mode table cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Gauge cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored text cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Colored background cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Show data links in the cell +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Json view cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Sparkline cell options +####### obj fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withWrapText + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withWrapText(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"lcd"`, `"gradient"` + +Enum expressing the possible display modes +for the bar gauge component of Grafana UI +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"color"`, `"text"`, `"hidden"` + +Allows for the table cell gauge display type to set the gauge mode. +####### obj fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withWrapText + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withWrapText(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"basic"`, `"gradient"` + +Display mode to the "Colored Background" display +mode for table cells. Either displays a solid color (basic mode) +or a gradient. +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType() +``` + + + +######## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withWrapText + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withWrapText(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### obj fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withAlt + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withAlt(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withTitle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType() +``` + + + +####### obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +######## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType() +``` + + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +######## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle + + +######### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCellHeight + +```jsonnet +options.withCellHeight(value="sm") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"sm"` + - valid values: `"sm"`, `"md"`, `"lg"`, `"auto"` + +Height of a table cell +#### fn options.withFooter + +```jsonnet +options.withFooter(value={"countRows": false,"reducer": null,"show": false}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"countRows": false,"reducer": null,"show": false}` + +Footer options +#### fn options.withFooterMixin + +```jsonnet +options.withFooterMixin(value={"countRows": false,"reducer": null,"show": false}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"countRows": false,"reducer": null,"show": false}` + +Footer options +#### fn options.withFrameIndex + +```jsonnet +options.withFrameIndex(value=0) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `0` + +Represents the index of the selected frame +#### fn options.withShowHeader + +```jsonnet +options.withShowHeader(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the panel should show the header +#### fn options.withShowTypeIcons + +```jsonnet +options.withShowTypeIcons(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls whether the header should show icons for the column types +#### fn options.withSortBy + +```jsonnet +options.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### fn options.withSortByMixin + +```jsonnet +options.withSortByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Used to control row sorting +#### obj options.footer + + +##### fn options.footer.withCountRows + +```jsonnet +options.footer.withCountRows(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withEnablePagination + +```jsonnet +options.footer.withEnablePagination(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.footer.withFields + +```jsonnet +options.footer.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withFieldsMixin + +```jsonnet +options.footer.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.footer.withReducer + +```jsonnet +options.footer.withReducer(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withReducerMixin + +```jsonnet +options.footer.withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +actually 1 value +##### fn options.footer.withShow + +```jsonnet +options.footer.withShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/options/sortBy.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/options/sortBy.md new file mode 100644 index 0000000..20748dc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/options/sortBy.md @@ -0,0 +1,34 @@ +# sortBy + + + +## Index + +* [`fn withDesc(value=true)`](#fn-withdesc) +* [`fn withDisplayName(value)`](#fn-withdisplayname) + +## Fields + +### fn withDesc + +```jsonnet +withDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag used to indicate descending sort order +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Sets the display name of the field to sort by \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/table/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/index.md new file mode 100644 index 0000000..d898bab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/index.md @@ -0,0 +1,742 @@ +# text + +grafonnet.panel.text + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withCode(value)`](#fn-optionswithcode) + * [`fn withCodeMixin(value)`](#fn-optionswithcodemixin) + * [`fn withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)")`](#fn-optionswithcontent) + * [`fn withMode(value="markdown")`](#fn-optionswithmode) + * [`obj code`](#obj-optionscode) + * [`fn withLanguage(value="plaintext")`](#fn-optionscodewithlanguage) + * [`fn withShowLineNumbers(value=true)`](#fn-optionscodewithshowlinenumbers) + * [`fn withShowMiniMap(value=true)`](#fn-optionscodewithshowminimap) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new text panel with a title. +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withCode + +```jsonnet +options.withCode(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withCodeMixin + +```jsonnet +options.withCodeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn options.withContent + +```jsonnet +options.withContent(value="# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)"` + + +#### fn options.withMode + +```jsonnet +options.withMode(value="markdown") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"markdown"` + - valid values: `"html"`, `"markdown"`, `"code"` + + +#### obj options.code + + +##### fn options.code.withLanguage + +```jsonnet +options.code.withLanguage(value="plaintext") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"plaintext"` + - valid values: `"json"`, `"yaml"`, `"xml"`, `"typescript"`, `"sql"`, `"go"`, `"markdown"`, `"html"`, `"plaintext"` + +The language passed to monaco code editor +##### fn options.code.withShowLineNumbers + +```jsonnet +options.code.withShowLineNumbers(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.code.withShowMiniMap + +```jsonnet +options.code.withShowMiniMap(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/text/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/index.md new file mode 100644 index 0000000..6c2101e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/index.md @@ -0,0 +1,1589 @@ +# timeSeries + +grafonnet.panel.timeSeries + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value={"calcs": [],"displayMode": "list","placement": "bottom"})`](#fn-optionswithlegend) + * [`fn withLegendMixin(value={"calcs": [],"displayMode": "list","placement": "bottom"})`](#fn-optionswithlegendmixin) + * [`fn withOrientation(value)`](#fn-optionswithorientation) + * [`fn withTimezone(value)`](#fn-optionswithtimezone) + * [`fn withTimezoneMixin(value)`](#fn-optionswithtimezonemixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new timeSeries panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value={"calcs": [],"displayMode": "list","placement": "bottom"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"calcs": [],"displayMode": "list","placement": "bottom"}` + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value={"calcs": [],"displayMode": "list","placement": "bottom"}) +``` + +PARAMETERS: + +* **value** (`object`) + - default value: `{"calcs": [],"displayMode": "list","placement": "bottom"}` + +TODO docs +#### fn options.withOrientation + +```jsonnet +options.withOrientation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"vertical"`, `"horizontal"` + +TODO docs +#### fn options.withTimezone + +```jsonnet +options.withTimezone(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTimezoneMixin + +```jsonnet +options.withTimezoneMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/timeSeries/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/index.md new file mode 100644 index 0000000..dcf118e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/index.md @@ -0,0 +1,1562 @@ +# trend + +grafonnet.panel.trend + +## Subpackages + +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withBarAlignment(value)`](#fn-fieldconfigdefaultscustomwithbaralignment) + * [`fn withBarMaxWidth(value)`](#fn-fieldconfigdefaultscustomwithbarmaxwidth) + * [`fn withBarWidthFactor(value)`](#fn-fieldconfigdefaultscustomwithbarwidthfactor) + * [`fn withDrawStyle(value)`](#fn-fieldconfigdefaultscustomwithdrawstyle) + * [`fn withFillBelowTo(value)`](#fn-fieldconfigdefaultscustomwithfillbelowto) + * [`fn withFillColor(value)`](#fn-fieldconfigdefaultscustomwithfillcolor) + * [`fn withFillOpacity(value)`](#fn-fieldconfigdefaultscustomwithfillopacity) + * [`fn withGradientMode(value)`](#fn-fieldconfigdefaultscustomwithgradientmode) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withInsertNulls(value)`](#fn-fieldconfigdefaultscustomwithinsertnulls) + * [`fn withInsertNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithinsertnullsmixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineInterpolation(value)`](#fn-fieldconfigdefaultscustomwithlineinterpolation) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSymbol(value)`](#fn-fieldconfigdefaultscustomwithpointsymbol) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShowPoints(value)`](#fn-fieldconfigdefaultscustomwithshowpoints) + * [`fn withSpanNulls(value)`](#fn-fieldconfigdefaultscustomwithspannulls) + * [`fn withSpanNullsMixin(value)`](#fn-fieldconfigdefaultscustomwithspannullsmixin) + * [`fn withStacking(value)`](#fn-fieldconfigdefaultscustomwithstacking) + * [`fn withStackingMixin(value)`](#fn-fieldconfigdefaultscustomwithstackingmixin) + * [`fn withThresholdsStyle(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstyle) + * [`fn withThresholdsStyleMixin(value)`](#fn-fieldconfigdefaultscustomwiththresholdsstylemixin) + * [`fn withTransform(value)`](#fn-fieldconfigdefaultscustomwithtransform) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) + * [`obj stacking`](#obj-fieldconfigdefaultscustomstacking) + * [`fn withGroup(value)`](#fn-fieldconfigdefaultscustomstackingwithgroup) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomstackingwithmode) + * [`obj thresholdsStyle`](#obj-fieldconfigdefaultscustomthresholdsstyle) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomthresholdsstylewithmode) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`fn withXField(value)`](#fn-optionswithxfield) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new trend panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarAlignment + +```jsonnet +fieldConfig.defaults.custom.withBarAlignment(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `-1`, `0`, `1` + +TODO docs +###### fn fieldConfig.defaults.custom.withBarMaxWidth + +```jsonnet +fieldConfig.defaults.custom.withBarMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withBarWidthFactor + +```jsonnet +fieldConfig.defaults.custom.withBarWidthFactor(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withDrawStyle + +```jsonnet +fieldConfig.defaults.custom.withDrawStyle(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"line"`, `"bars"`, `"points"` + +TODO docs +###### fn fieldConfig.defaults.custom.withFillBelowTo + +```jsonnet +fieldConfig.defaults.custom.withFillBelowTo(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillColor + +```jsonnet +fieldConfig.defaults.custom.withFillColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withFillOpacity + +```jsonnet +fieldConfig.defaults.custom.withFillOpacity(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withGradientMode + +```jsonnet +fieldConfig.defaults.custom.withGradientMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"opacity"`, `"hue"`, `"scheme"` + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withInsertNulls + +```jsonnet +fieldConfig.defaults.custom.withInsertNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withInsertNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withInsertNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withLineInterpolation + +```jsonnet +fieldConfig.defaults.custom.withLineInterpolation(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"smooth"`, `"stepBefore"`, `"stepAfter"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withPointSymbol + +```jsonnet +fieldConfig.defaults.custom.withPointSymbol(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShowPoints + +```jsonnet +fieldConfig.defaults.custom.withShowPoints(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withSpanNulls + +```jsonnet +fieldConfig.defaults.custom.withSpanNulls(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withSpanNullsMixin + +```jsonnet +fieldConfig.defaults.custom.withSpanNullsMixin(value) +``` + +PARAMETERS: + +* **value** (`boolean`,`number`) + +Indicate if null values should be treated as gaps or connected. +When the value is a number, it represents the maximum delta in the +X axis that should be considered connected. For timeseries, this is milliseconds +###### fn fieldConfig.defaults.custom.withStacking + +```jsonnet +fieldConfig.defaults.custom.withStacking(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withStackingMixin + +```jsonnet +fieldConfig.defaults.custom.withStackingMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyle + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withThresholdsStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withThresholdsStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withTransform + +```jsonnet +fieldConfig.defaults.custom.withTransform(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"constant"`, `"negative-Y"` + +TODO docs +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +###### obj fieldConfig.defaults.custom.stacking + + +####### fn fieldConfig.defaults.custom.stacking.withGroup + +```jsonnet +fieldConfig.defaults.custom.stacking.withGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.stacking.withMode + +```jsonnet +fieldConfig.defaults.custom.stacking.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"normal"`, `"percent"` + +TODO docs +###### obj fieldConfig.defaults.custom.thresholdsStyle + + +####### fn fieldConfig.defaults.custom.thresholdsStyle.withMode + +```jsonnet +fieldConfig.defaults.custom.thresholdsStyle.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"off"`, `"line"`, `"dashed"`, `"area"`, `"line+area"`, `"dashed+area"`, `"series"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withXField + +```jsonnet +options.withXField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the x field to use (defaults to first number) +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/trend/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/index.md new file mode 100644 index 0000000..06cbfe4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/index.md @@ -0,0 +1,1618 @@ +# xyChart + +grafonnet.panel.xyChart + +## Subpackages + +* [options.series](options/series.md) +* [panelOptions.link](panelOptions/link.md) +* [queryOptions.transformation](queryOptions/transformation.md) +* [standardOptions.mapping](standardOptions/mapping.md) +* [standardOptions.override](standardOptions/override.md) +* [standardOptions.threshold.step](standardOptions/threshold/step.md) + +## Index + +* [`fn new(title)`](#fn-new) +* [`obj fieldConfig`](#obj-fieldconfig) + * [`obj defaults`](#obj-fieldconfigdefaults) + * [`obj custom`](#obj-fieldconfigdefaultscustom) + * [`fn withAxisBorderShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisbordershow) + * [`fn withAxisCenteredZero(value=true)`](#fn-fieldconfigdefaultscustomwithaxiscenteredzero) + * [`fn withAxisColorMode(value)`](#fn-fieldconfigdefaultscustomwithaxiscolormode) + * [`fn withAxisGridShow(value=true)`](#fn-fieldconfigdefaultscustomwithaxisgridshow) + * [`fn withAxisLabel(value)`](#fn-fieldconfigdefaultscustomwithaxislabel) + * [`fn withAxisPlacement(value)`](#fn-fieldconfigdefaultscustomwithaxisplacement) + * [`fn withAxisSoftMax(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmax) + * [`fn withAxisSoftMin(value)`](#fn-fieldconfigdefaultscustomwithaxissoftmin) + * [`fn withAxisWidth(value)`](#fn-fieldconfigdefaultscustomwithaxiswidth) + * [`fn withHideFrom(value)`](#fn-fieldconfigdefaultscustomwithhidefrom) + * [`fn withHideFromMixin(value)`](#fn-fieldconfigdefaultscustomwithhidefrommixin) + * [`fn withLabel(value="auto")`](#fn-fieldconfigdefaultscustomwithlabel) + * [`fn withLabelValue(value)`](#fn-fieldconfigdefaultscustomwithlabelvalue) + * [`fn withLabelValueMixin(value)`](#fn-fieldconfigdefaultscustomwithlabelvaluemixin) + * [`fn withLineColor(value)`](#fn-fieldconfigdefaultscustomwithlinecolor) + * [`fn withLineColorMixin(value)`](#fn-fieldconfigdefaultscustomwithlinecolormixin) + * [`fn withLineStyle(value)`](#fn-fieldconfigdefaultscustomwithlinestyle) + * [`fn withLineStyleMixin(value)`](#fn-fieldconfigdefaultscustomwithlinestylemixin) + * [`fn withLineWidth(value)`](#fn-fieldconfigdefaultscustomwithlinewidth) + * [`fn withPointColor(value)`](#fn-fieldconfigdefaultscustomwithpointcolor) + * [`fn withPointColorMixin(value)`](#fn-fieldconfigdefaultscustomwithpointcolormixin) + * [`fn withPointSize(value)`](#fn-fieldconfigdefaultscustomwithpointsize) + * [`fn withPointSizeMixin(value)`](#fn-fieldconfigdefaultscustomwithpointsizemixin) + * [`fn withScaleDistribution(value)`](#fn-fieldconfigdefaultscustomwithscaledistribution) + * [`fn withScaleDistributionMixin(value)`](#fn-fieldconfigdefaultscustomwithscaledistributionmixin) + * [`fn withShow(value="points")`](#fn-fieldconfigdefaultscustomwithshow) + * [`obj hideFrom`](#obj-fieldconfigdefaultscustomhidefrom) + * [`fn withLegend(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-fieldconfigdefaultscustomhidefromwithviz) + * [`obj labelValue`](#obj-fieldconfigdefaultscustomlabelvalue) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithfixed) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustomlabelvaluewithmode) + * [`obj lineColor`](#obj-fieldconfigdefaultscustomlinecolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustomlinecolorwithfixed) + * [`obj lineStyle`](#obj-fieldconfigdefaultscustomlinestyle) + * [`fn withDash(value)`](#fn-fieldconfigdefaultscustomlinestylewithdash) + * [`fn withDashMixin(value)`](#fn-fieldconfigdefaultscustomlinestylewithdashmixin) + * [`fn withFill(value)`](#fn-fieldconfigdefaultscustomlinestylewithfill) + * [`obj pointColor`](#obj-fieldconfigdefaultscustompointcolor) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointcolorwithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointcolorwithfixed) + * [`obj pointSize`](#obj-fieldconfigdefaultscustompointsize) + * [`fn withField(value)`](#fn-fieldconfigdefaultscustompointsizewithfield) + * [`fn withFixed(value)`](#fn-fieldconfigdefaultscustompointsizewithfixed) + * [`fn withMax(value)`](#fn-fieldconfigdefaultscustompointsizewithmax) + * [`fn withMin(value)`](#fn-fieldconfigdefaultscustompointsizewithmin) + * [`fn withMode(value)`](#fn-fieldconfigdefaultscustompointsizewithmode) + * [`obj scaleDistribution`](#obj-fieldconfigdefaultscustomscaledistribution) + * [`fn withLinearThreshold(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithlog) + * [`fn withType(value)`](#fn-fieldconfigdefaultscustomscaledistributionwithtype) +* [`obj libraryPanel`](#obj-librarypanel) + * [`fn withName(value)`](#fn-librarypanelwithname) + * [`fn withUid(value)`](#fn-librarypanelwithuid) +* [`obj options`](#obj-options) + * [`fn withDims(value)`](#fn-optionswithdims) + * [`fn withDimsMixin(value)`](#fn-optionswithdimsmixin) + * [`fn withLegend(value)`](#fn-optionswithlegend) + * [`fn withLegendMixin(value)`](#fn-optionswithlegendmixin) + * [`fn withSeries(value)`](#fn-optionswithseries) + * [`fn withSeriesMapping(value)`](#fn-optionswithseriesmapping) + * [`fn withSeriesMixin(value)`](#fn-optionswithseriesmixin) + * [`fn withTooltip(value)`](#fn-optionswithtooltip) + * [`fn withTooltipMixin(value)`](#fn-optionswithtooltipmixin) + * [`obj dims`](#obj-optionsdims) + * [`fn withExclude(value)`](#fn-optionsdimswithexclude) + * [`fn withExcludeMixin(value)`](#fn-optionsdimswithexcludemixin) + * [`fn withFrame(value)`](#fn-optionsdimswithframe) + * [`fn withX(value)`](#fn-optionsdimswithx) + * [`obj legend`](#obj-optionslegend) + * [`fn withAsTable(value=true)`](#fn-optionslegendwithastable) + * [`fn withCalcs(value=[])`](#fn-optionslegendwithcalcs) + * [`fn withCalcsMixin(value=[])`](#fn-optionslegendwithcalcsmixin) + * [`fn withDisplayMode(value="list")`](#fn-optionslegendwithdisplaymode) + * [`fn withIsVisible(value=true)`](#fn-optionslegendwithisvisible) + * [`fn withPlacement(value="bottom")`](#fn-optionslegendwithplacement) + * [`fn withShowLegend(value=true)`](#fn-optionslegendwithshowlegend) + * [`fn withSortBy(value)`](#fn-optionslegendwithsortby) + * [`fn withSortDesc(value=true)`](#fn-optionslegendwithsortdesc) + * [`fn withWidth(value)`](#fn-optionslegendwithwidth) + * [`obj tooltip`](#obj-optionstooltip) + * [`fn withMaxHeight(value)`](#fn-optionstooltipwithmaxheight) + * [`fn withMaxWidth(value)`](#fn-optionstooltipwithmaxwidth) + * [`fn withMode(value)`](#fn-optionstooltipwithmode) + * [`fn withSort(value)`](#fn-optionstooltipwithsort) +* [`obj panelOptions`](#obj-paneloptions) + * [`fn withDescription(value)`](#fn-paneloptionswithdescription) + * [`fn withGridPos(h="null", w="null", x="null", y="null")`](#fn-paneloptionswithgridpos) + * [`fn withLinks(value)`](#fn-paneloptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-paneloptionswithlinksmixin) + * [`fn withMaxPerRow(value)`](#fn-paneloptionswithmaxperrow) + * [`fn withRepeat(value)`](#fn-paneloptionswithrepeat) + * [`fn withRepeatDirection(value="h")`](#fn-paneloptionswithrepeatdirection) + * [`fn withTitle(value)`](#fn-paneloptionswithtitle) + * [`fn withTransparent(value=true)`](#fn-paneloptionswithtransparent) +* [`obj queryOptions`](#obj-queryoptions) + * [`fn withDatasource(type, uid)`](#fn-queryoptionswithdatasource) + * [`fn withDatasourceMixin(value)`](#fn-queryoptionswithdatasourcemixin) + * [`fn withHideTimeOverride(value=true)`](#fn-queryoptionswithhidetimeoverride) + * [`fn withInterval(value)`](#fn-queryoptionswithinterval) + * [`fn withMaxDataPoints(value)`](#fn-queryoptionswithmaxdatapoints) + * [`fn withQueryCachingTTL(value)`](#fn-queryoptionswithquerycachingttl) + * [`fn withTargets(value)`](#fn-queryoptionswithtargets) + * [`fn withTargetsMixin(value)`](#fn-queryoptionswithtargetsmixin) + * [`fn withTimeFrom(value)`](#fn-queryoptionswithtimefrom) + * [`fn withTimeShift(value)`](#fn-queryoptionswithtimeshift) + * [`fn withTransformations(value)`](#fn-queryoptionswithtransformations) + * [`fn withTransformationsMixin(value)`](#fn-queryoptionswithtransformationsmixin) +* [`obj standardOptions`](#obj-standardoptions) + * [`fn withDecimals(value)`](#fn-standardoptionswithdecimals) + * [`fn withDisplayName(value)`](#fn-standardoptionswithdisplayname) + * [`fn withFilterable(value=true)`](#fn-standardoptionswithfilterable) + * [`fn withLinks(value)`](#fn-standardoptionswithlinks) + * [`fn withLinksMixin(value)`](#fn-standardoptionswithlinksmixin) + * [`fn withMappings(value)`](#fn-standardoptionswithmappings) + * [`fn withMappingsMixin(value)`](#fn-standardoptionswithmappingsmixin) + * [`fn withMax(value)`](#fn-standardoptionswithmax) + * [`fn withMin(value)`](#fn-standardoptionswithmin) + * [`fn withNoValue(value)`](#fn-standardoptionswithnovalue) + * [`fn withOverrides(value)`](#fn-standardoptionswithoverrides) + * [`fn withOverridesMixin(value)`](#fn-standardoptionswithoverridesmixin) + * [`fn withPath(value)`](#fn-standardoptionswithpath) + * [`fn withUnit(value)`](#fn-standardoptionswithunit) + * [`obj color`](#obj-standardoptionscolor) + * [`fn withFixedColor(value)`](#fn-standardoptionscolorwithfixedcolor) + * [`fn withMode(value)`](#fn-standardoptionscolorwithmode) + * [`fn withSeriesBy(value)`](#fn-standardoptionscolorwithseriesby) + * [`obj thresholds`](#obj-standardoptionsthresholds) + * [`fn withMode(value)`](#fn-standardoptionsthresholdswithmode) + * [`fn withSteps(value)`](#fn-standardoptionsthresholdswithsteps) + * [`fn withStepsMixin(value)`](#fn-standardoptionsthresholdswithstepsmixin) + +## Fields + +### fn new + +```jsonnet +new(title) +``` + +PARAMETERS: + +* **title** (`string`) + +Creates a new xyChart panel with a title. +### obj fieldConfig + + +#### obj fieldConfig.defaults + + +##### obj fieldConfig.defaults.custom + + +###### fn fieldConfig.defaults.custom.withAxisBorderShow + +```jsonnet +fieldConfig.defaults.custom.withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisCenteredZero + +```jsonnet +fieldConfig.defaults.custom.withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisColorMode + +```jsonnet +fieldConfig.defaults.custom.withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisGridShow + +```jsonnet +fieldConfig.defaults.custom.withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### fn fieldConfig.defaults.custom.withAxisLabel + +```jsonnet +fieldConfig.defaults.custom.withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn fieldConfig.defaults.custom.withAxisPlacement + +```jsonnet +fieldConfig.defaults.custom.withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +###### fn fieldConfig.defaults.custom.withAxisSoftMax + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisSoftMin + +```jsonnet +fieldConfig.defaults.custom.withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withAxisWidth + +```jsonnet +fieldConfig.defaults.custom.withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +###### fn fieldConfig.defaults.custom.withHideFrom + +```jsonnet +fieldConfig.defaults.custom.withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withHideFromMixin + +```jsonnet +fieldConfig.defaults.custom.withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLabel + +```jsonnet +fieldConfig.defaults.custom.withLabel(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +###### fn fieldConfig.defaults.custom.withLabelValue + +```jsonnet +fieldConfig.defaults.custom.withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLabelValueMixin + +```jsonnet +fieldConfig.defaults.custom.withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColor + +```jsonnet +fieldConfig.defaults.custom.withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineColorMixin + +```jsonnet +fieldConfig.defaults.custom.withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withLineStyle + +```jsonnet +fieldConfig.defaults.custom.withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineStyleMixin + +```jsonnet +fieldConfig.defaults.custom.withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withLineWidth + +```jsonnet +fieldConfig.defaults.custom.withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +###### fn fieldConfig.defaults.custom.withPointColor + +```jsonnet +fieldConfig.defaults.custom.withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointColorMixin + +```jsonnet +fieldConfig.defaults.custom.withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSize + +```jsonnet +fieldConfig.defaults.custom.withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withPointSizeMixin + +```jsonnet +fieldConfig.defaults.custom.withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn fieldConfig.defaults.custom.withScaleDistribution + +```jsonnet +fieldConfig.defaults.custom.withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withScaleDistributionMixin + +```jsonnet +fieldConfig.defaults.custom.withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +###### fn fieldConfig.defaults.custom.withShow + +```jsonnet +fieldConfig.defaults.custom.withShow(value="points") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"points"` + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +###### obj fieldConfig.defaults.custom.hideFrom + + +####### fn fieldConfig.defaults.custom.hideFrom.withLegend + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withTooltip + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +####### fn fieldConfig.defaults.custom.hideFrom.withViz + +```jsonnet +fieldConfig.defaults.custom.hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +###### obj fieldConfig.defaults.custom.labelValue + + +####### fn fieldConfig.defaults.custom.labelValue.withField + +```jsonnet +fieldConfig.defaults.custom.labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.labelValue.withFixed + +```jsonnet +fieldConfig.defaults.custom.labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn fieldConfig.defaults.custom.labelValue.withMode + +```jsonnet +fieldConfig.defaults.custom.labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +###### obj fieldConfig.defaults.custom.lineColor + + +####### fn fieldConfig.defaults.custom.lineColor.withField + +```jsonnet +fieldConfig.defaults.custom.lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.lineColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.lineStyle + + +####### fn fieldConfig.defaults.custom.lineStyle.withDash + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withDashMixin + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn fieldConfig.defaults.custom.lineStyle.withFill + +```jsonnet +fieldConfig.defaults.custom.lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +###### obj fieldConfig.defaults.custom.pointColor + + +####### fn fieldConfig.defaults.custom.pointColor.withField + +```jsonnet +fieldConfig.defaults.custom.pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointColor.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +###### obj fieldConfig.defaults.custom.pointSize + + +####### fn fieldConfig.defaults.custom.pointSize.withField + +```jsonnet +fieldConfig.defaults.custom.pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +####### fn fieldConfig.defaults.custom.pointSize.withFixed + +```jsonnet +fieldConfig.defaults.custom.pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMax + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMin + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.pointSize.withMode + +```jsonnet +fieldConfig.defaults.custom.pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + +| *"linear" +###### obj fieldConfig.defaults.custom.scaleDistribution + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withLog + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +####### fn fieldConfig.defaults.custom.scaleDistribution.withType + +```jsonnet +fieldConfig.defaults.custom.scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs +### obj libraryPanel + + +#### fn libraryPanel.withName + +```jsonnet +libraryPanel.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel name +#### fn libraryPanel.withUid + +```jsonnet +libraryPanel.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Library panel uid +### obj options + + +#### fn options.withDims + +```jsonnet +options.withDims(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withDimsMixin + +```jsonnet +options.withDimsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Configuration for the Table/Auto mode +#### fn options.withLegend + +```jsonnet +options.withLegend(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withLegendMixin + +```jsonnet +options.withLegendMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withSeries + +```jsonnet +options.withSeries(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withSeriesMapping + +```jsonnet +options.withSeriesMapping(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"manual"` + +Auto is "table" in the UI +#### fn options.withSeriesMixin + +```jsonnet +options.withSeriesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Manual Mode +#### fn options.withTooltip + +```jsonnet +options.withTooltip(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### fn options.withTooltipMixin + +```jsonnet +options.withTooltipMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +#### obj options.dims + + +##### fn options.dims.withExclude + +```jsonnet +options.dims.withExclude(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withExcludeMixin + +```jsonnet +options.dims.withExcludeMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn options.dims.withFrame + +```jsonnet +options.dims.withFrame(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +##### fn options.dims.withX + +```jsonnet +options.dims.withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj options.legend + + +##### fn options.legend.withAsTable + +```jsonnet +options.legend.withAsTable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withCalcs + +```jsonnet +options.legend.withCalcs(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withCalcsMixin + +```jsonnet +options.legend.withCalcsMixin(value=[]) +``` + +PARAMETERS: + +* **value** (`array`) + - default value: `[]` + + +##### fn options.legend.withDisplayMode + +```jsonnet +options.legend.withDisplayMode(value="list") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"list"` + - valid values: `"list"`, `"table"`, `"hidden"` + +TODO docs +Note: "hidden" needs to remain as an option for plugins compatibility +##### fn options.legend.withIsVisible + +```jsonnet +options.legend.withIsVisible(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withPlacement + +```jsonnet +options.legend.withPlacement(value="bottom") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"bottom"` + - valid values: `"bottom"`, `"right"` + +TODO docs +##### fn options.legend.withShowLegend + +```jsonnet +options.legend.withShowLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withSortBy + +```jsonnet +options.legend.withSortBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn options.legend.withSortDesc + +```jsonnet +options.legend.withSortDesc(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn options.legend.withWidth + +```jsonnet +options.legend.withWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### obj options.tooltip + + +##### fn options.tooltip.withMaxHeight + +```jsonnet +options.tooltip.withMaxHeight(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMaxWidth + +```jsonnet +options.tooltip.withMaxWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn options.tooltip.withMode + +```jsonnet +options.tooltip.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"single"`, `"multi"`, `"none"` + +TODO docs +##### fn options.tooltip.withSort + +```jsonnet +options.tooltip.withSort(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"asc"`, `"desc"`, `"none"` + +TODO docs +### obj panelOptions + + +#### fn panelOptions.withDescription + +```jsonnet +panelOptions.withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel description. +#### fn panelOptions.withGridPos + +```jsonnet +panelOptions.withGridPos(h="null", w="null", x="null", y="null") +``` + +PARAMETERS: + +* **h** (`number`) + - default value: `"null"` +* **w** (`number`) + - default value: `"null"` +* **x** (`number`) + - default value: `"null"` +* **y** (`number`) + - default value: `"null"` + +`withGridPos` configures the height, width and xy coordinates of the panel. Also see `grafonnet.util.grid` for helper functions to calculate these fields. + +All arguments default to `null`, which means they will remain unchanged or unset. + +#### fn panelOptions.withLinks + +```jsonnet +panelOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withLinksMixin + +```jsonnet +panelOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Panel links. +#### fn panelOptions.withMaxPerRow + +```jsonnet +panelOptions.withMaxPerRow(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Option for repeated panels that controls max items per row +Only relevant for horizontally repeated panels +#### fn panelOptions.withRepeat + +```jsonnet +panelOptions.withRepeat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of template variable to repeat for. +#### fn panelOptions.withRepeatDirection + +```jsonnet +panelOptions.withRepeatDirection(value="h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"h"` + - valid values: `"h"`, `"v"` + +Direction to repeat in if 'repeat' is set. +`h` for horizontal, `v` for vertical. +#### fn panelOptions.withTitle + +```jsonnet +panelOptions.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Panel title. +#### fn panelOptions.withTransparent + +```jsonnet +panelOptions.withTransparent(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Whether to display the panel without a background. +### obj queryOptions + + +#### fn queryOptions.withDatasource + +```jsonnet +queryOptions.withDatasource(type, uid) +``` + +PARAMETERS: + +* **type** (`string`) +* **uid** (`string`) + +`withDatasource` sets the datasource for all queries in a panel. + +The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason. + +#### fn queryOptions.withDatasourceMixin + +```jsonnet +queryOptions.withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +#### fn queryOptions.withHideTimeOverride + +```jsonnet +queryOptions.withHideTimeOverride(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Controls if the timeFrom or timeShift overrides are shown in the panel header +#### fn queryOptions.withInterval + +```jsonnet +queryOptions.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. +This value must be formatted as a number followed by a valid time +identifier like: "40s", "3d", etc. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withMaxDataPoints + +```jsonnet +queryOptions.withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum number of data points that the panel queries are retrieving. +#### fn queryOptions.withQueryCachingTTL + +```jsonnet +queryOptions.withQueryCachingTTL(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Overrides the data source configured time-to-live for a query cache item in milliseconds +#### fn queryOptions.withTargets + +```jsonnet +queryOptions.withTargets(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTargetsMixin + +```jsonnet +queryOptions.withTargetsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Depends on the panel plugin. See the plugin documentation for details. +#### fn queryOptions.withTimeFrom + +```jsonnet +queryOptions.withTimeFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the relative time range for individual panels, +which causes them to be different than what is selected in +the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different +time periods or days on the same dashboard. +The value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far), +`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years). +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTimeShift + +```jsonnet +queryOptions.withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Overrides the time range for individual panels by shifting its start and end relative to the time picker. +For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. +Note: Panel time overrides have no effect when the dashboard’s time range is absolute. +See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options +#### fn queryOptions.withTransformations + +```jsonnet +queryOptions.withTransformations(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +#### fn queryOptions.withTransformationsMixin + +```jsonnet +queryOptions.withTransformationsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of transformations that are applied to the panel data before rendering. +When there are multiple transformations, Grafana applies them in the order they are listed. +Each transformation creates a result set that then passes on to the next transformation in the processing pipeline. +### obj standardOptions + + +#### fn standardOptions.withDecimals + +```jsonnet +standardOptions.withDecimals(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Specify the number of decimals Grafana includes in the rendered value. +If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. +For example 1.1234 will display as 1.12 and 100.456 will display as 100. +To display all decimals, set the unit to `String`. +#### fn standardOptions.withDisplayName + +```jsonnet +standardOptions.withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The display value for this field. This supports template variables blank is auto +#### fn standardOptions.withFilterable + +```jsonnet +standardOptions.withFilterable(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +True if data source field supports ad-hoc filters +#### fn standardOptions.withLinks + +```jsonnet +standardOptions.withLinks(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withLinksMixin + +```jsonnet +standardOptions.withLinksMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +The behavior when clicking on a result +#### fn standardOptions.withMappings + +```jsonnet +standardOptions.withMappings(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMappingsMixin + +```jsonnet +standardOptions.withMappingsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Convert input values into a display string +#### fn standardOptions.withMax + +```jsonnet +standardOptions.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withMin + +```jsonnet +standardOptions.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + +The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields. +#### fn standardOptions.withNoValue + +```jsonnet +standardOptions.withNoValue(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alternative to empty string +#### fn standardOptions.withOverrides + +```jsonnet +standardOptions.withOverrides(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withOverridesMixin + +```jsonnet +standardOptions.withOverridesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Overrides are the options applied to specific fields overriding the defaults. +#### fn standardOptions.withPath + +```jsonnet +standardOptions.withPath(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An explicit path to the field in the datasource. When the frame meta includes a path, +This will default to `${frame.meta.path}/${field.name} + +When defined, this value can be used as an identifier within the datasource scope, and +may be used to update the results +#### fn standardOptions.withUnit + +```jsonnet +standardOptions.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unit a field should use. The unit you select is applied to all fields except time. +You can use the units ID availables in Grafana or a custom unit. +Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts +As custom unit, you can use the following formats: +`suffix:` for custom unit that should go after value. +`prefix:` for custom unit that should go before value. +`time:` For custom date time formats type for example `time:YYYY-MM-DD`. +`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. +`count:` for a custom count unit. +`currency:` for custom a currency unit. +#### obj standardOptions.color + + +##### fn standardOptions.color.withFixedColor + +```jsonnet +standardOptions.color.withFixedColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The fixed color value for fixed or shades color modes. +##### fn standardOptions.color.withMode + +```jsonnet +standardOptions.color.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"thresholds"`, `"palette-classic"`, `"palette-classic-by-name"`, `"continuous-GrYlRd"`, `"continuous-RdYlGr"`, `"continuous-BlYlRd"`, `"continuous-YlRd"`, `"continuous-BlPu"`, `"continuous-YlBl"`, `"continuous-blues"`, `"continuous-reds"`, `"continuous-greens"`, `"continuous-purples"`, `"fixed"`, `"shades"` + +Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. +Continuous color interpolates a color using the percentage of a value relative to min and max. +Accepted values are: +`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold +`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations +`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations +`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode +`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode +`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode +`continuous-YlRd`: Continuous Yellow-Red palette mode +`continuous-BlPu`: Continuous Blue-Purple palette mode +`continuous-YlBl`: Continuous Yellow-Blue palette mode +`continuous-blues`: Continuous Blue palette mode +`continuous-reds`: Continuous Red palette mode +`continuous-greens`: Continuous Green palette mode +`continuous-purples`: Continuous Purple palette mode +`shades`: Shades of a single color. Specify a single color, useful in an override rule. +`fixed`: Fixed color mode. Specify a single color, useful in an override rule. +##### fn standardOptions.color.withSeriesBy + +```jsonnet +standardOptions.color.withSeriesBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"min"`, `"max"`, `"last"` + +Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value. +#### obj standardOptions.thresholds + + +##### fn standardOptions.thresholds.withMode + +```jsonnet +standardOptions.thresholds.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"absolute"`, `"percentage"` + +Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1). +##### fn standardOptions.thresholds.withSteps + +```jsonnet +standardOptions.thresholds.withSteps(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity +##### fn standardOptions.thresholds.withStepsMixin + +```jsonnet +standardOptions.thresholds.withStepsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Must be sorted by 'value', first value is always -Infinity \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/options/series.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/options/series.md new file mode 100644 index 0000000..042a580 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/options/series.md @@ -0,0 +1,665 @@ +# series + + + +## Index + +* [`fn withAxisBorderShow(value=true)`](#fn-withaxisbordershow) +* [`fn withAxisCenteredZero(value=true)`](#fn-withaxiscenteredzero) +* [`fn withAxisColorMode(value)`](#fn-withaxiscolormode) +* [`fn withAxisGridShow(value=true)`](#fn-withaxisgridshow) +* [`fn withAxisLabel(value)`](#fn-withaxislabel) +* [`fn withAxisPlacement(value)`](#fn-withaxisplacement) +* [`fn withAxisSoftMax(value)`](#fn-withaxissoftmax) +* [`fn withAxisSoftMin(value)`](#fn-withaxissoftmin) +* [`fn withAxisWidth(value)`](#fn-withaxiswidth) +* [`fn withFrame(value)`](#fn-withframe) +* [`fn withHideFrom(value)`](#fn-withhidefrom) +* [`fn withHideFromMixin(value)`](#fn-withhidefrommixin) +* [`fn withLabel(value="auto")`](#fn-withlabel) +* [`fn withLabelValue(value)`](#fn-withlabelvalue) +* [`fn withLabelValueMixin(value)`](#fn-withlabelvaluemixin) +* [`fn withLineColor(value)`](#fn-withlinecolor) +* [`fn withLineColorMixin(value)`](#fn-withlinecolormixin) +* [`fn withLineStyle(value)`](#fn-withlinestyle) +* [`fn withLineStyleMixin(value)`](#fn-withlinestylemixin) +* [`fn withLineWidth(value)`](#fn-withlinewidth) +* [`fn withName(value)`](#fn-withname) +* [`fn withPointColor(value)`](#fn-withpointcolor) +* [`fn withPointColorMixin(value)`](#fn-withpointcolormixin) +* [`fn withPointSize(value)`](#fn-withpointsize) +* [`fn withPointSizeMixin(value)`](#fn-withpointsizemixin) +* [`fn withScaleDistribution(value)`](#fn-withscaledistribution) +* [`fn withScaleDistributionMixin(value)`](#fn-withscaledistributionmixin) +* [`fn withShow(value="points")`](#fn-withshow) +* [`fn withX(value)`](#fn-withx) +* [`fn withY(value)`](#fn-withy) +* [`obj hideFrom`](#obj-hidefrom) + * [`fn withLegend(value=true)`](#fn-hidefromwithlegend) + * [`fn withTooltip(value=true)`](#fn-hidefromwithtooltip) + * [`fn withViz(value=true)`](#fn-hidefromwithviz) +* [`obj labelValue`](#obj-labelvalue) + * [`fn withField(value)`](#fn-labelvaluewithfield) + * [`fn withFixed(value)`](#fn-labelvaluewithfixed) + * [`fn withMode(value)`](#fn-labelvaluewithmode) +* [`obj lineColor`](#obj-linecolor) + * [`fn withField(value)`](#fn-linecolorwithfield) + * [`fn withFixed(value)`](#fn-linecolorwithfixed) +* [`obj lineStyle`](#obj-linestyle) + * [`fn withDash(value)`](#fn-linestylewithdash) + * [`fn withDashMixin(value)`](#fn-linestylewithdashmixin) + * [`fn withFill(value)`](#fn-linestylewithfill) +* [`obj pointColor`](#obj-pointcolor) + * [`fn withField(value)`](#fn-pointcolorwithfield) + * [`fn withFixed(value)`](#fn-pointcolorwithfixed) +* [`obj pointSize`](#obj-pointsize) + * [`fn withField(value)`](#fn-pointsizewithfield) + * [`fn withFixed(value)`](#fn-pointsizewithfixed) + * [`fn withMax(value)`](#fn-pointsizewithmax) + * [`fn withMin(value)`](#fn-pointsizewithmin) + * [`fn withMode(value)`](#fn-pointsizewithmode) +* [`obj scaleDistribution`](#obj-scaledistribution) + * [`fn withLinearThreshold(value)`](#fn-scaledistributionwithlinearthreshold) + * [`fn withLog(value)`](#fn-scaledistributionwithlog) + * [`fn withType(value)`](#fn-scaledistributionwithtype) + +## Fields + +### fn withAxisBorderShow + +```jsonnet +withAxisBorderShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisCenteredZero + +```jsonnet +withAxisCenteredZero(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisColorMode + +```jsonnet +withAxisColorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"text"`, `"series"` + +TODO docs +### fn withAxisGridShow + +```jsonnet +withAxisGridShow(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withAxisLabel + +```jsonnet +withAxisLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withAxisPlacement + +```jsonnet +withAxisPlacement(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"auto"`, `"top"`, `"right"`, `"bottom"`, `"left"`, `"hidden"` + +TODO docs +### fn withAxisSoftMax + +```jsonnet +withAxisSoftMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisSoftMin + +```jsonnet +withAxisSoftMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withAxisWidth + +```jsonnet +withAxisWidth(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withFrame + +```jsonnet +withFrame(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withHideFrom + +```jsonnet +withHideFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withHideFromMixin + +```jsonnet +withHideFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLabel + +```jsonnet +withLabel(value="auto") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"auto"` + - valid values: `"auto"`, `"never"`, `"always"` + +TODO docs +### fn withLabelValue + +```jsonnet +withLabelValue(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLabelValueMixin + +```jsonnet +withLabelValueMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColor + +```jsonnet +withLineColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineColorMixin + +```jsonnet +withLineColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLineStyle + +```jsonnet +withLineStyle(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineStyleMixin + +```jsonnet +withLineStyleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withLineWidth + +```jsonnet +withLineWidth(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPointColor + +```jsonnet +withPointColor(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointColorMixin + +```jsonnet +withPointColorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSize + +```jsonnet +withPointSize(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPointSizeMixin + +```jsonnet +withPointSizeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withScaleDistribution + +```jsonnet +withScaleDistribution(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withScaleDistributionMixin + +```jsonnet +withScaleDistributionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TODO docs +### fn withShow + +```jsonnet +withShow(value="points") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"points"` + - valid values: `"points"`, `"lines"`, `"points+lines"` + + +### fn withX + +```jsonnet +withX(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withY + +```jsonnet +withY(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj hideFrom + + +#### fn hideFrom.withLegend + +```jsonnet +hideFrom.withLegend(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withTooltip + +```jsonnet +hideFrom.withTooltip(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn hideFrom.withViz + +```jsonnet +hideFrom.withViz(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj labelValue + + +#### fn labelValue.withField + +```jsonnet +labelValue.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn labelValue.withFixed + +```jsonnet +labelValue.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn labelValue.withMode + +```jsonnet +labelValue.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fixed"`, `"field"`, `"template"` + + +### obj lineColor + + +#### fn lineColor.withField + +```jsonnet +lineColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn lineColor.withFixed + +```jsonnet +lineColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj lineStyle + + +#### fn lineStyle.withDash + +```jsonnet +lineStyle.withDash(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withDashMixin + +```jsonnet +lineStyle.withDashMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn lineStyle.withFill + +```jsonnet +lineStyle.withFill(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"solid"`, `"dash"`, `"dot"`, `"square"` + + +### obj pointColor + + +#### fn pointColor.withField + +```jsonnet +pointColor.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointColor.withFixed + +```jsonnet +pointColor.withFixed(value) +``` + +PARAMETERS: + +* **value** (`string`) + +color value +### obj pointSize + + +#### fn pointSize.withField + +```jsonnet +pointSize.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +fixed: T -- will be added by each element +#### fn pointSize.withFixed + +```jsonnet +pointSize.withFixed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMax + +```jsonnet +pointSize.withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMin + +```jsonnet +pointSize.withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pointSize.withMode + +```jsonnet +pointSize.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"quad"` + +| *"linear" +### obj scaleDistribution + + +#### fn scaleDistribution.withLinearThreshold + +```jsonnet +scaleDistribution.withLinearThreshold(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withLog + +```jsonnet +scaleDistribution.withLog(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn scaleDistribution.withType + +```jsonnet +scaleDistribution.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"linear"`, `"log"`, `"ordinal"`, `"symlog"` + +TODO docs \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/panelOptions/link.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/panelOptions/link.md new file mode 100644 index 0000000..d744fc5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/panelOptions/link.md @@ -0,0 +1,146 @@ +# link + + + +## Index + +* [`fn withAsDropdown(value=true)`](#fn-withasdropdown) +* [`fn withIcon(value)`](#fn-withicon) +* [`fn withIncludeVars(value=true)`](#fn-withincludevars) +* [`fn withKeepTime(value=true)`](#fn-withkeeptime) +* [`fn withTags(value)`](#fn-withtags) +* [`fn withTagsMixin(value)`](#fn-withtagsmixin) +* [`fn withTargetBlank(value=true)`](#fn-withtargetblank) +* [`fn withTitle(value)`](#fn-withtitle) +* [`fn withTooltip(value)`](#fn-withtooltip) +* [`fn withType(value)`](#fn-withtype) +* [`fn withUrl(value)`](#fn-withurl) + +## Fields + +### fn withAsDropdown + +```jsonnet +withAsDropdown(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +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 +### fn withIcon + +```jsonnet +withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon name to be displayed with the link +### fn withIncludeVars + +```jsonnet +withIncludeVars(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current template variables values in the link as query params +### fn withKeepTime + +```jsonnet +withKeepTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, includes current time range in the link as query params +### fn withTags + +```jsonnet +withTags(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTagsMixin + +```jsonnet +withTagsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards +### fn withTargetBlank + +```jsonnet +withTargetBlank(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If true, the link will be opened in a new tab +### fn withTitle + +```jsonnet +withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Title to display with the link +### fn withTooltip + +```jsonnet +withTooltip(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Tooltip to display when the user hovers their mouse over it +### fn withType + +```jsonnet +withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"link"`, `"dashboards"` + +Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource) +### fn withUrl + +```jsonnet +withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Link URL. Only required/valid if the type is link \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/queryOptions/transformation.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/queryOptions/transformation.md new file mode 100644 index 0000000..69dda9a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/queryOptions/transformation.md @@ -0,0 +1,140 @@ +# transformation + + + +## Index + +* [`fn withDisabled(value=true)`](#fn-withdisabled) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilterMixin(value)`](#fn-withfiltermixin) +* [`fn withId(value)`](#fn-withid) +* [`fn withOptions(value)`](#fn-withoptions) +* [`fn withOptionsMixin(value)`](#fn-withoptionsmixin) +* [`fn withTopic(value)`](#fn-withtopic) +* [`obj filter`](#obj-filter) + * [`fn withId(value="")`](#fn-filterwithid) + * [`fn withOptions(value)`](#fn-filterwithoptions) + * [`fn withOptionsMixin(value)`](#fn-filterwithoptionsmixin) + +## Fields + +### fn withDisabled + +```jsonnet +withDisabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Disabled transformations are skipped +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withFilterMixin + +```jsonnet +withFilterMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. +It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique identifier of transformer +### fn withOptions + +```jsonnet +withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withOptionsMixin + +```jsonnet +withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Options to be passed to the transformer +Valid options depend on the transformer id +### fn withTopic + +```jsonnet +withTopic(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"series"`, `"annotations"`, `"alertStates"` + +Where to pull DataFrames from as input to transformation +### obj filter + + +#### fn filter.withId + +```jsonnet +filter.withId(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + +The matcher id. This is used to find the matcher implementation from registry. +#### fn filter.withOptions + +```jsonnet +filter.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. +#### fn filter.withOptionsMixin + +```jsonnet +filter.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The matcher options. This is specific to the matcher implementation. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/mapping.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/mapping.md new file mode 100644 index 0000000..196c769 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/mapping.md @@ -0,0 +1,445 @@ +# mapping + + + +## Index + +* [`obj RangeMap`](#obj-rangemap) + * [`fn withOptions(value)`](#fn-rangemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-rangemapwithoptionsmixin) + * [`fn withType()`](#fn-rangemapwithtype) + * [`obj options`](#obj-rangemapoptions) + * [`fn withFrom(value)`](#fn-rangemapoptionswithfrom) + * [`fn withResult(value)`](#fn-rangemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-rangemapoptionswithresultmixin) + * [`fn withTo(value)`](#fn-rangemapoptionswithto) + * [`obj result`](#obj-rangemapoptionsresult) + * [`fn withColor(value)`](#fn-rangemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-rangemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-rangemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-rangemapoptionsresultwithtext) +* [`obj RegexMap`](#obj-regexmap) + * [`fn withOptions(value)`](#fn-regexmapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-regexmapwithoptionsmixin) + * [`fn withType()`](#fn-regexmapwithtype) + * [`obj options`](#obj-regexmapoptions) + * [`fn withPattern(value)`](#fn-regexmapoptionswithpattern) + * [`fn withResult(value)`](#fn-regexmapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-regexmapoptionswithresultmixin) + * [`obj result`](#obj-regexmapoptionsresult) + * [`fn withColor(value)`](#fn-regexmapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-regexmapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-regexmapoptionsresultwithindex) + * [`fn withText(value)`](#fn-regexmapoptionsresultwithtext) +* [`obj SpecialValueMap`](#obj-specialvaluemap) + * [`fn withOptions(value)`](#fn-specialvaluemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-specialvaluemapwithoptionsmixin) + * [`fn withType()`](#fn-specialvaluemapwithtype) + * [`obj options`](#obj-specialvaluemapoptions) + * [`fn withMatch(value)`](#fn-specialvaluemapoptionswithmatch) + * [`fn withResult(value)`](#fn-specialvaluemapoptionswithresult) + * [`fn withResultMixin(value)`](#fn-specialvaluemapoptionswithresultmixin) + * [`obj result`](#obj-specialvaluemapoptionsresult) + * [`fn withColor(value)`](#fn-specialvaluemapoptionsresultwithcolor) + * [`fn withIcon(value)`](#fn-specialvaluemapoptionsresultwithicon) + * [`fn withIndex(value)`](#fn-specialvaluemapoptionsresultwithindex) + * [`fn withText(value)`](#fn-specialvaluemapoptionsresultwithtext) +* [`obj ValueMap`](#obj-valuemap) + * [`fn withOptions(value)`](#fn-valuemapwithoptions) + * [`fn withOptionsMixin(value)`](#fn-valuemapwithoptionsmixin) + * [`fn withType()`](#fn-valuemapwithtype) + +## Fields + +### obj RangeMap + + +#### fn RangeMap.withOptions + +```jsonnet +RangeMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withOptionsMixin + +```jsonnet +RangeMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Range to match against and the result to apply when the value is within the range +#### fn RangeMap.withType + +```jsonnet +RangeMap.withType() +``` + + + +#### obj RangeMap.options + + +##### fn RangeMap.options.withFrom + +```jsonnet +RangeMap.options.withFrom(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Min value of the range. It can be null which means -Infinity +##### fn RangeMap.options.withResult + +```jsonnet +RangeMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withResultMixin + +```jsonnet +RangeMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RangeMap.options.withTo + +```jsonnet +RangeMap.options.withTo(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Max value of the range. It can be null which means +Infinity +##### obj RangeMap.options.result + + +###### fn RangeMap.options.result.withColor + +```jsonnet +RangeMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RangeMap.options.result.withIcon + +```jsonnet +RangeMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RangeMap.options.result.withIndex + +```jsonnet +RangeMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RangeMap.options.result.withText + +```jsonnet +RangeMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj RegexMap + + +#### fn RegexMap.withOptions + +```jsonnet +RegexMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withOptionsMixin + +```jsonnet +RegexMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Regular expression to match against and the result to apply when the value matches the regex +#### fn RegexMap.withType + +```jsonnet +RegexMap.withType() +``` + + + +#### obj RegexMap.options + + +##### fn RegexMap.options.withPattern + +```jsonnet +RegexMap.options.withPattern(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Regular expression to match against +##### fn RegexMap.options.withResult + +```jsonnet +RegexMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn RegexMap.options.withResultMixin + +```jsonnet +RegexMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj RegexMap.options.result + + +###### fn RegexMap.options.result.withColor + +```jsonnet +RegexMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn RegexMap.options.result.withIcon + +```jsonnet +RegexMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn RegexMap.options.result.withIndex + +```jsonnet +RegexMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn RegexMap.options.result.withText + +```jsonnet +RegexMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj SpecialValueMap + + +#### fn SpecialValueMap.withOptions + +```jsonnet +SpecialValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withOptionsMixin + +```jsonnet +SpecialValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn SpecialValueMap.withType + +```jsonnet +SpecialValueMap.withType() +``` + + + +#### obj SpecialValueMap.options + + +##### fn SpecialValueMap.options.withMatch + +```jsonnet +SpecialValueMap.options.withMatch(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"true"`, `"false"`, `"null"`, `"nan"`, `"null+nan"`, `"empty"` + +Special value types supported by the `SpecialValueMap` +##### fn SpecialValueMap.options.withResult + +```jsonnet +SpecialValueMap.options.withResult(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### fn SpecialValueMap.options.withResultMixin + +```jsonnet +SpecialValueMap.options.withResultMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Result used as replacement with text and color when the value matches +##### obj SpecialValueMap.options.result + + +###### fn SpecialValueMap.options.result.withColor + +```jsonnet +SpecialValueMap.options.result.withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to use when the value matches +###### fn SpecialValueMap.options.result.withIcon + +```jsonnet +SpecialValueMap.options.result.withIcon(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Icon to display when the value matches. Only specific visualizations. +###### fn SpecialValueMap.options.result.withIndex + +```jsonnet +SpecialValueMap.options.result.withIndex(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Position in the mapping array. Only used internally. +###### fn SpecialValueMap.options.result.withText + +```jsonnet +SpecialValueMap.options.result.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Text to display when the value matches +### obj ValueMap + + +#### fn ValueMap.withOptions + +```jsonnet +ValueMap.withOptions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withOptionsMixin + +```jsonnet +ValueMap.withOptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } } +#### fn ValueMap.withType + +```jsonnet +ValueMap.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/override.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/override.md new file mode 100644 index 0000000..2997ad7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/override.md @@ -0,0 +1,244 @@ +# override + +Overrides allow you to customize visualization settings for specific fields or +series. This is accomplished by adding an override rule that targets +a particular set of fields and that can each define multiple options. + +```jsonnet +override.byType.new('number') ++ override.byType.withPropertiesFromOptions( + panel.standardOptions.withDecimals(2) + + panel.standardOptions.withUnit('s') +) +``` + + +## Index + +* [`obj byName`](#obj-byname) + * [`fn new(value)`](#fn-bynamenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bynamewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bynamewithproperty) +* [`obj byQuery`](#obj-byquery) + * [`fn new(value)`](#fn-byquerynew) + * [`fn withPropertiesFromOptions(options)`](#fn-byquerywithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byquerywithproperty) +* [`obj byRegexp`](#obj-byregexp) + * [`fn new(value)`](#fn-byregexpnew) + * [`fn withPropertiesFromOptions(options)`](#fn-byregexpwithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byregexpwithproperty) +* [`obj byType`](#obj-bytype) + * [`fn new(value)`](#fn-bytypenew) + * [`fn withPropertiesFromOptions(options)`](#fn-bytypewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-bytypewithproperty) +* [`obj byValue`](#obj-byvalue) + * [`fn new(value)`](#fn-byvaluenew) + * [`fn withPropertiesFromOptions(options)`](#fn-byvaluewithpropertiesfromoptions) + * [`fn withProperty(id, value)`](#fn-byvaluewithproperty) + +## Fields + +### obj byName + + +#### fn byName.new + +```jsonnet +byName.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byName`. +#### fn byName.withPropertiesFromOptions + +```jsonnet +byName.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byName.withProperty + +```jsonnet +byName.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byQuery + + +#### fn byQuery.new + +```jsonnet +byQuery.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byFrameRefID`. +#### fn byQuery.withPropertiesFromOptions + +```jsonnet +byQuery.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byQuery.withProperty + +```jsonnet +byQuery.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byRegexp + + +#### fn byRegexp.new + +```jsonnet +byRegexp.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byRegexp`. +#### fn byRegexp.withPropertiesFromOptions + +```jsonnet +byRegexp.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byRegexp.withProperty + +```jsonnet +byRegexp.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byType + + +#### fn byType.new + +```jsonnet +byType.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byType`. +#### fn byType.withPropertiesFromOptions + +```jsonnet +byType.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byType.withProperty + +```jsonnet +byType.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. + +### obj byValue + + +#### fn byValue.new + +```jsonnet +byValue.new(value) +``` + +PARAMETERS: + +* **value** (`string`) + +`new` creates a new override of type `byValue`. +#### fn byValue.withPropertiesFromOptions + +```jsonnet +byValue.withPropertiesFromOptions(options) +``` + +PARAMETERS: + +* **options** (`object`) + +`withPropertiesFromOptions` takes an object with properties that need to be +overridden. See example code above. + +#### fn byValue.withProperty + +```jsonnet +byValue.withProperty(id, value) +``` + +PARAMETERS: + +* **id** (`string`) +* **value** (`any`) + +`withProperty` adds a property that needs to be overridden. This function can +be called multiple time, adding more properties. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/threshold/step.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/threshold/step.md new file mode 100644 index 0000000..62c49ab --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/panel/xyChart/standardOptions/threshold/step.md @@ -0,0 +1,34 @@ +# threshold.step + + + +## Index + +* [`fn withColor(value)`](#fn-withcolor) +* [`fn withValue(value)`](#fn-withvalue) + +## Fields + +### fn withColor + +```jsonnet +withColor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded. +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded. +Nulls currently appear here when serializing -Infinity to JSON. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/preferences.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/preferences.md new file mode 100644 index 0000000..d780022 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/preferences.md @@ -0,0 +1,262 @@ +# preferences + +grafonnet.preferences + +## Index + +* [`fn withCookiePreferences(value)`](#fn-withcookiepreferences) +* [`fn withCookiePreferencesMixin(value)`](#fn-withcookiepreferencesmixin) +* [`fn withHomeDashboardUID(value)`](#fn-withhomedashboarduid) +* [`fn withLanguage(value)`](#fn-withlanguage) +* [`fn withNavbar(value)`](#fn-withnavbar) +* [`fn withNavbarMixin(value)`](#fn-withnavbarmixin) +* [`fn withQueryHistory(value)`](#fn-withqueryhistory) +* [`fn withQueryHistoryMixin(value)`](#fn-withqueryhistorymixin) +* [`fn withTheme(value)`](#fn-withtheme) +* [`fn withTimezone(value)`](#fn-withtimezone) +* [`fn withWeekStart(value)`](#fn-withweekstart) +* [`obj cookiePreferences`](#obj-cookiepreferences) + * [`fn withAnalytics(value)`](#fn-cookiepreferenceswithanalytics) + * [`fn withAnalyticsMixin(value)`](#fn-cookiepreferenceswithanalyticsmixin) + * [`fn withFunctional(value)`](#fn-cookiepreferenceswithfunctional) + * [`fn withFunctionalMixin(value)`](#fn-cookiepreferenceswithfunctionalmixin) + * [`fn withPerformance(value)`](#fn-cookiepreferenceswithperformance) + * [`fn withPerformanceMixin(value)`](#fn-cookiepreferenceswithperformancemixin) +* [`obj navbar`](#obj-navbar) + * [`fn withBookmarkUrls(value)`](#fn-navbarwithbookmarkurls) + * [`fn withBookmarkUrlsMixin(value)`](#fn-navbarwithbookmarkurlsmixin) +* [`obj queryHistory`](#obj-queryhistory) + * [`fn withHomeTab(value)`](#fn-queryhistorywithhometab) + +## Fields + +### fn withCookiePreferences + +```jsonnet +withCookiePreferences(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Cookie preferences +### fn withCookiePreferencesMixin + +```jsonnet +withCookiePreferencesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Cookie preferences +### fn withHomeDashboardUID + +```jsonnet +withHomeDashboardUID(value) +``` + +PARAMETERS: + +* **value** (`string`) + +UID for the home dashboard +### fn withLanguage + +```jsonnet +withLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Selected language (beta) +### fn withNavbar + +```jsonnet +withNavbar(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Navigation preferences +### fn withNavbarMixin + +```jsonnet +withNavbarMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Navigation preferences +### fn withQueryHistory + +```jsonnet +withQueryHistory(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Explore query history preferences +### fn withQueryHistoryMixin + +```jsonnet +withQueryHistoryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Explore query history preferences +### fn withTheme + +```jsonnet +withTheme(value) +``` + +PARAMETERS: + +* **value** (`string`) + +light, dark, empty is default +### fn withTimezone + +```jsonnet +withTimezone(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The timezone selection +TODO: this should use the timezone defined in common +### fn withWeekStart + +```jsonnet +withWeekStart(value) +``` + +PARAMETERS: + +* **value** (`string`) + +day of the week (sunday, monday, etc) +### obj cookiePreferences + + +#### fn cookiePreferences.withAnalytics + +```jsonnet +cookiePreferences.withAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withAnalyticsMixin + +```jsonnet +cookiePreferences.withAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctional + +```jsonnet +cookiePreferences.withFunctional(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withFunctionalMixin + +```jsonnet +cookiePreferences.withFunctionalMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformance + +```jsonnet +cookiePreferences.withPerformance(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn cookiePreferences.withPerformanceMixin + +```jsonnet +cookiePreferences.withPerformanceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj navbar + + +#### fn navbar.withBookmarkUrls + +```jsonnet +navbar.withBookmarkUrls(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn navbar.withBookmarkUrlsMixin + +```jsonnet +navbar.withBookmarkUrlsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj queryHistory + + +#### fn queryHistory.withHomeTab + +```jsonnet +queryHistory.withHomeTab(value) +``` + +PARAMETERS: + +* **value** (`string`) + +one of: '' | 'query' | 'starred'; \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/publicdashboard.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/publicdashboard.md new file mode 100644 index 0000000..9cb78fb --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/publicdashboard.md @@ -0,0 +1,84 @@ +# publicdashboard + +grafonnet.publicdashboard + +## Index + +* [`fn withAccessToken(value)`](#fn-withaccesstoken) +* [`fn withAnnotationsEnabled(value=true)`](#fn-withannotationsenabled) +* [`fn withDashboardUid(value)`](#fn-withdashboarduid) +* [`fn withIsEnabled(value=true)`](#fn-withisenabled) +* [`fn withTimeSelectionEnabled(value=true)`](#fn-withtimeselectionenabled) +* [`fn withUid(value)`](#fn-withuid) + +## Fields + +### fn withAccessToken + +```jsonnet +withAccessToken(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public access token +### fn withAnnotationsEnabled + +```jsonnet +withAnnotationsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if annotations are enabled +### fn withDashboardUid + +```jsonnet +withDashboardUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Dashboard unique identifier referenced by this public dashboard +### fn withIsEnabled + +```jsonnet +withIsEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the public dashboard is enabled +### fn withTimeSelectionEnabled + +```jsonnet +withTimeSelectionEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Flag that indicates if the time range picker is enabled +### fn withUid + +```jsonnet +withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Unique public dashboard identifier \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/athena.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/athena.md new file mode 100644 index 0000000..74b4153 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/athena.md @@ -0,0 +1,256 @@ +# athena + +grafonnet.query.athena + +## Index + +* [`fn withColumn(value)`](#fn-withcolumn) +* [`fn withConnectionArgs(value)`](#fn-withconnectionargs) +* [`fn withConnectionArgsMixin(value)`](#fn-withconnectionargsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withQueryID(value)`](#fn-withqueryid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawSQL(value="")`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTable(value)`](#fn-withtable) +* [`obj connectionArgs`](#obj-connectionargs) + * [`fn withCatalog(value="__default")`](#fn-connectionargswithcatalog) + * [`fn withDatabase(value="__default")`](#fn-connectionargswithdatabase) + * [`fn withRegion(value="__default")`](#fn-connectionargswithregion) + * [`fn withResultReuseEnabled(value=true)`](#fn-connectionargswithresultreuseenabled) + * [`fn withResultReuseMaxAgeInMinutes(value=60)`](#fn-connectionargswithresultreusemaxageinminutes) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withColumn + +```jsonnet +withColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withConnectionArgs + +```jsonnet +withConnectionArgs(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withConnectionArgsMixin + +```jsonnet +withConnectionArgsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1`, `2` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withQueryID + +```jsonnet +withQueryID(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawSQL + +```jsonnet +withRawSQL(value="") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `""` + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj connectionArgs + + +#### fn connectionArgs.withCatalog + +```jsonnet +connectionArgs.withCatalog(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withDatabase + +```jsonnet +connectionArgs.withDatabase(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withRegion + +```jsonnet +connectionArgs.withRegion(value="__default") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"__default"` + + +#### fn connectionArgs.withResultReuseEnabled + +```jsonnet +connectionArgs.withResultReuseEnabled(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn connectionArgs.withResultReuseMaxAgeInMinutes + +```jsonnet +connectionArgs.withResultReuseMaxAgeInMinutes(value=60) +``` + +PARAMETERS: + +* **value** (`number`) + - default value: `60` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md new file mode 100644 index 0000000..43b6cf5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/dimensionFilters.md @@ -0,0 +1,69 @@ +# dimensionFilters + + + +## Index + +* [`fn withDimension(value)`](#fn-withdimension) +* [`fn withFilter(value)`](#fn-withfilter) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperator(value)`](#fn-withoperator) + +## Fields + +### fn withDimension + +```jsonnet +withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of Dimension to be filtered on. +### fn withFilter + +```jsonnet +withFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated filter is deprecated in favour of filters to support multiselect. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to match with the filter. +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/resources.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/resources.md new file mode 100644 index 0000000..18bb633 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureMonitor/resources.md @@ -0,0 +1,68 @@ +# resources + + + +## Index + +* [`fn withMetricNamespace(value)`](#fn-withmetricnamespace) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withResourceName(value)`](#fn-withresourcename) +* [`fn withSubscription(value)`](#fn-withsubscription) + +## Fields + +### fn withMetricNamespace + +```jsonnet +withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceName + +```jsonnet +withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureTraces/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureTraces/filters.md new file mode 100644 index 0000000..0c5c718 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/azureTraces/filters.md @@ -0,0 +1,57 @@ +# filters + + + +## Index + +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withOperation(value)`](#fn-withoperation) +* [`fn withProperty(value)`](#fn-withproperty) + +## Fields + +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Values to filter by. +### fn withOperation + +```jsonnet +withOperation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Comparison operator to use. Either equals or not equals. +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Property name, auto-populated based on available traces. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/index.md new file mode 100644 index 0000000..386256b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/azureMonitor/index.md @@ -0,0 +1,1547 @@ +# azureMonitor + +grafonnet.query.azureMonitor + +## Subpackages + +* [azureMonitor.dimensionFilters](azureMonitor/dimensionFilters.md) +* [azureMonitor.resources](azureMonitor/resources.md) +* [azureTraces.filters](azureTraces/filters.md) + +## Index + +* [`fn withAzureLogAnalytics(value)`](#fn-withazureloganalytics) +* [`fn withAzureLogAnalyticsMixin(value)`](#fn-withazureloganalyticsmixin) +* [`fn withAzureMonitor(value)`](#fn-withazuremonitor) +* [`fn withAzureMonitorMixin(value)`](#fn-withazuremonitormixin) +* [`fn withAzureResourceGraph(value)`](#fn-withazureresourcegraph) +* [`fn withAzureResourceGraphMixin(value)`](#fn-withazureresourcegraphmixin) +* [`fn withAzureTraces(value)`](#fn-withazuretraces) +* [`fn withAzureTracesMixin(value)`](#fn-withazuretracesmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withGrafanaTemplateVariableFn(value)`](#fn-withgrafanatemplatevariablefn) +* [`fn withGrafanaTemplateVariableFnMixin(value)`](#fn-withgrafanatemplatevariablefnmixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withNamespace(value)`](#fn-withnamespace) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withRegion(value)`](#fn-withregion) +* [`fn withResource(value)`](#fn-withresource) +* [`fn withResourceGroup(value)`](#fn-withresourcegroup) +* [`fn withSubscription(value)`](#fn-withsubscription) +* [`fn withSubscriptions(value)`](#fn-withsubscriptions) +* [`fn withSubscriptionsMixin(value)`](#fn-withsubscriptionsmixin) +* [`obj azureLogAnalytics`](#obj-azureloganalytics) + * [`fn withBasicLogsQuery(value=true)`](#fn-azureloganalyticswithbasiclogsquery) + * [`fn withDashboardTime(value=true)`](#fn-azureloganalyticswithdashboardtime) + * [`fn withIntersectTime(value=true)`](#fn-azureloganalyticswithintersecttime) + * [`fn withQuery(value)`](#fn-azureloganalyticswithquery) + * [`fn withResource(value)`](#fn-azureloganalyticswithresource) + * [`fn withResources(value)`](#fn-azureloganalyticswithresources) + * [`fn withResourcesMixin(value)`](#fn-azureloganalyticswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azureloganalyticswithresultformat) + * [`fn withTimeColumn(value)`](#fn-azureloganalyticswithtimecolumn) + * [`fn withWorkspace(value)`](#fn-azureloganalyticswithworkspace) +* [`obj azureMonitor`](#obj-azuremonitor) + * [`fn withAggregation(value)`](#fn-azuremonitorwithaggregation) + * [`fn withAlias(value)`](#fn-azuremonitorwithalias) + * [`fn withAllowedTimeGrainsMs(value)`](#fn-azuremonitorwithallowedtimegrainsms) + * [`fn withAllowedTimeGrainsMsMixin(value)`](#fn-azuremonitorwithallowedtimegrainsmsmixin) + * [`fn withCustomNamespace(value)`](#fn-azuremonitorwithcustomnamespace) + * [`fn withDimension(value)`](#fn-azuremonitorwithdimension) + * [`fn withDimensionFilter(value)`](#fn-azuremonitorwithdimensionfilter) + * [`fn withDimensionFilters(value)`](#fn-azuremonitorwithdimensionfilters) + * [`fn withDimensionFiltersMixin(value)`](#fn-azuremonitorwithdimensionfiltersmixin) + * [`fn withMetricDefinition(value)`](#fn-azuremonitorwithmetricdefinition) + * [`fn withMetricName(value)`](#fn-azuremonitorwithmetricname) + * [`fn withMetricNamespace(value)`](#fn-azuremonitorwithmetricnamespace) + * [`fn withRegion(value)`](#fn-azuremonitorwithregion) + * [`fn withResourceGroup(value)`](#fn-azuremonitorwithresourcegroup) + * [`fn withResourceName(value)`](#fn-azuremonitorwithresourcename) + * [`fn withResourceUri(value)`](#fn-azuremonitorwithresourceuri) + * [`fn withResources(value)`](#fn-azuremonitorwithresources) + * [`fn withResourcesMixin(value)`](#fn-azuremonitorwithresourcesmixin) + * [`fn withTimeGrain(value)`](#fn-azuremonitorwithtimegrain) + * [`fn withTimeGrainUnit(value)`](#fn-azuremonitorwithtimegrainunit) + * [`fn withTop(value)`](#fn-azuremonitorwithtop) +* [`obj azureResourceGraph`](#obj-azureresourcegraph) + * [`fn withQuery(value)`](#fn-azureresourcegraphwithquery) + * [`fn withResultFormat(value)`](#fn-azureresourcegraphwithresultformat) +* [`obj azureTraces`](#obj-azuretraces) + * [`fn withFilters(value)`](#fn-azuretraceswithfilters) + * [`fn withFiltersMixin(value)`](#fn-azuretraceswithfiltersmixin) + * [`fn withOperationId(value)`](#fn-azuretraceswithoperationid) + * [`fn withQuery(value)`](#fn-azuretraceswithquery) + * [`fn withResources(value)`](#fn-azuretraceswithresources) + * [`fn withResourcesMixin(value)`](#fn-azuretraceswithresourcesmixin) + * [`fn withResultFormat(value)`](#fn-azuretraceswithresultformat) + * [`fn withTraceTypes(value)`](#fn-azuretraceswithtracetypes) + * [`fn withTraceTypesMixin(value)`](#fn-azuretraceswithtracetypesmixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj grafanaTemplateVariableFn`](#obj-grafanatemplatevariablefn) + * [`fn withAppInsightsGroupByQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquery) + * [`fn withAppInsightsGroupByQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsgroupbyquerymixin) + * [`fn withAppInsightsMetricNameQuery(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequery) + * [`fn withAppInsightsMetricNameQueryMixin(value)`](#fn-grafanatemplatevariablefnwithappinsightsmetricnamequerymixin) + * [`fn withMetricDefinitionsQuery(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquery) + * [`fn withMetricDefinitionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricdefinitionsquerymixin) + * [`fn withMetricNamesQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquery) + * [`fn withMetricNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamesquerymixin) + * [`fn withMetricNamespaceQuery(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequery) + * [`fn withMetricNamespaceQueryMixin(value)`](#fn-grafanatemplatevariablefnwithmetricnamespacequerymixin) + * [`fn withResourceGroupsQuery(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquery) + * [`fn withResourceGroupsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcegroupsquerymixin) + * [`fn withResourceNamesQuery(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquery) + * [`fn withResourceNamesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithresourcenamesquerymixin) + * [`fn withSubscriptionsQuery(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquery) + * [`fn withSubscriptionsQueryMixin(value)`](#fn-grafanatemplatevariablefnwithsubscriptionsquerymixin) + * [`fn withUnknownQuery(value)`](#fn-grafanatemplatevariablefnwithunknownquery) + * [`fn withUnknownQueryMixin(value)`](#fn-grafanatemplatevariablefnwithunknownquerymixin) + * [`fn withWorkspacesQuery(value)`](#fn-grafanatemplatevariablefnwithworkspacesquery) + * [`fn withWorkspacesQueryMixin(value)`](#fn-grafanatemplatevariablefnwithworkspacesquerymixin) + * [`obj AppInsightsGroupByQuery`](#obj-grafanatemplatevariablefnappinsightsgroupbyquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithkind) + * [`fn withMetricName(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithmetricname) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsgroupbyquerywithrawquery) + * [`obj AppInsightsMetricNameQuery`](#obj-grafanatemplatevariablefnappinsightsmetricnamequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnappinsightsmetricnamequerywithrawquery) + * [`obj MetricDefinitionsQuery`](#obj-grafanatemplatevariablefnmetricdefinitionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricdefinitionsquerywithsubscription) + * [`obj MetricNamesQuery`](#obj-grafanatemplatevariablefnmetricnamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamesquerywithsubscription) + * [`obj MetricNamespaceQuery`](#obj-grafanatemplatevariablefnmetricnamespacequery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnmetricnamespacequerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcegroup) + * [`fn withResourceName(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithresourcename) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnmetricnamespacequerywithsubscription) + * [`obj ResourceGroupsQuery`](#obj-grafanatemplatevariablefnresourcegroupsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcegroupsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcegroupsquerywithsubscription) + * [`obj ResourceNamesQuery`](#obj-grafanatemplatevariablefnresourcenamesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnresourcenamesquerywithkind) + * [`fn withMetricNamespace(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithmetricnamespace) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithrawquery) + * [`fn withResourceGroup(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithresourcegroup) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnresourcenamesquerywithsubscription) + * [`obj SubscriptionsQuery`](#obj-grafanatemplatevariablefnsubscriptionsquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnsubscriptionsquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnsubscriptionsquerywithrawquery) + * [`obj UnknownQuery`](#obj-grafanatemplatevariablefnunknownquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnunknownquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnunknownquerywithrawquery) + * [`obj WorkspacesQuery`](#obj-grafanatemplatevariablefnworkspacesquery) + * [`fn withKind()`](#fn-grafanatemplatevariablefnworkspacesquerywithkind) + * [`fn withRawQuery(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithrawquery) + * [`fn withSubscription(value)`](#fn-grafanatemplatevariablefnworkspacesquerywithsubscription) + +## Fields + +### fn withAzureLogAnalytics + +```jsonnet +withAzureLogAnalytics(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureLogAnalyticsMixin + +```jsonnet +withAzureLogAnalyticsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Logs sub-query properties +### fn withAzureMonitor + +```jsonnet +withAzureMonitor(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Metrics sub-query properties. +### fn withAzureMonitorMixin + +```jsonnet +withAzureMonitorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Monitor Metrics sub-query properties. +### fn withAzureResourceGraph + +```jsonnet +withAzureResourceGraph(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Resource Graph sub-query properties. +### fn withAzureResourceGraphMixin + +```jsonnet +withAzureResourceGraphMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Azure Resource Graph sub-query properties. +### fn withAzureTraces + +```jsonnet +withAzureTraces(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withAzureTracesMixin + +```jsonnet +withAzureTracesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Application Insights Traces sub-query properties +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withGrafanaTemplateVariableFn + +```jsonnet +withGrafanaTemplateVariableFn(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Legacy template variable support. +### fn withGrafanaTemplateVariableFnMixin + +```jsonnet +withGrafanaTemplateVariableFnMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Legacy template variable support. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withNamespace + +```jsonnet +withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used only for exemplar queries from Prometheus +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withRegion + +```jsonnet +withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResource + +```jsonnet +withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withResourceGroup + +```jsonnet +withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Template variables params. These exist for backwards compatiblity with legacy template variables. +### fn withSubscription + +```jsonnet +withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure subscription containing the resource(s) to be queried. +### fn withSubscriptions + +```jsonnet +withSubscriptions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### fn withSubscriptionsMixin + +```jsonnet +withSubscriptionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Subscriptions to be queried via Azure Resource Graph. +### obj azureLogAnalytics + + +#### fn azureLogAnalytics.withBasicLogsQuery + +```jsonnet +azureLogAnalytics.withBasicLogsQuery(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If set to true the query will be run as a basic logs query +#### fn azureLogAnalytics.withDashboardTime + +```jsonnet +azureLogAnalytics.withDashboardTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false. +#### fn azureLogAnalytics.withIntersectTime + +```jsonnet +azureLogAnalytics.withIntersectTime(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated Use dashboardTime instead +#### fn azureLogAnalytics.withQuery + +```jsonnet +azureLogAnalytics.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureLogAnalytics.withResource + +```jsonnet +azureLogAnalytics.withResource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureLogAnalytics.withResources + +```jsonnet +azureLogAnalytics.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResourcesMixin + +```jsonnet +azureLogAnalytics.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureLogAnalytics.withResultFormat + +```jsonnet +azureLogAnalytics.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + +Specifies the format results should be returned as. +#### fn azureLogAnalytics.withTimeColumn + +```jsonnet +azureLogAnalytics.withTimeColumn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated +#### fn azureLogAnalytics.withWorkspace + +```jsonnet +azureLogAnalytics.withWorkspace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Workspace ID. This was removed in Grafana 8, but remains for backwards compat. +### obj azureMonitor + + +#### fn azureMonitor.withAggregation + +```jsonnet +azureMonitor.withAggregation(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric. +#### fn azureMonitor.withAlias + +```jsonnet +azureMonitor.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail. +#### fn azureMonitor.withAllowedTimeGrainsMs + +```jsonnet +azureMonitor.withAllowedTimeGrainsMs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withAllowedTimeGrainsMsMixin + +```jsonnet +azureMonitor.withAllowedTimeGrainsMsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Time grains that are supported by the metric. +#### fn azureMonitor.withCustomNamespace + +```jsonnet +azureMonitor.withCustomNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used as the value for the metricNamespace property when it's different from the resource namespace. +#### fn azureMonitor.withDimension + +```jsonnet +azureMonitor.withDimension(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilter + +```jsonnet +azureMonitor.withDimensionFilter(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration +#### fn azureMonitor.withDimensionFilters + +```jsonnet +azureMonitor.withDimensionFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withDimensionFiltersMixin + +```jsonnet +azureMonitor.withDimensionFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric. +#### fn azureMonitor.withMetricDefinition + +```jsonnet +azureMonitor.withMetricDefinition(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use metricNamespace instead +#### fn azureMonitor.withMetricName + +```jsonnet +azureMonitor.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The metric to query data for within the specified metricNamespace. e.g. UsedCapacity +#### fn azureMonitor.withMetricNamespace + +```jsonnet +azureMonitor.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +metricNamespace is used as the resource type (or resource namespace). +It's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts +Kept the name of the variable as metricNamespace to avoid backward incompatibility issues. +#### fn azureMonitor.withRegion + +```jsonnet +azureMonitor.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The Azure region containing the resource(s). +#### fn azureMonitor.withResourceGroup + +```jsonnet +azureMonitor.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceName + +```jsonnet +azureMonitor.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resources instead +#### fn azureMonitor.withResourceUri + +```jsonnet +azureMonitor.withResourceUri(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Use resourceGroup, resourceName and metricNamespace instead +#### fn azureMonitor.withResources + +```jsonnet +azureMonitor.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withResourcesMixin + +```jsonnet +azureMonitor.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureMonitor.withTimeGrain + +```jsonnet +azureMonitor.withTimeGrain(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The granularity of data points to be queried. Defaults to auto. +#### fn azureMonitor.withTimeGrainUnit + +```jsonnet +azureMonitor.withTimeGrainUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated +#### fn azureMonitor.withTop + +```jsonnet +azureMonitor.withTop(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Maximum number of records to return. Defaults to 10. +### obj azureResourceGraph + + +#### fn azureResourceGraph.withQuery + +```jsonnet +azureResourceGraph.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Azure Resource Graph KQL query to be executed. +#### fn azureResourceGraph.withResultFormat + +```jsonnet +azureResourceGraph.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the format results should be returned as. Defaults to table. +### obj azureTraces + + +#### fn azureTraces.withFilters + +```jsonnet +azureTraces.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withFiltersMixin + +```jsonnet +azureTraces.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters for property values. +#### fn azureTraces.withOperationId + +```jsonnet +azureTraces.withOperationId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Operation ID. Used only for Traces queries. +#### fn azureTraces.withQuery + +```jsonnet +azureTraces.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +KQL query to be executed. +#### fn azureTraces.withResources + +```jsonnet +azureTraces.withResources(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResourcesMixin + +```jsonnet +azureTraces.withResourcesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of resource URIs to be queried. +#### fn azureTraces.withResultFormat + +```jsonnet +azureTraces.withResultFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"table"`, `"time_series"`, `"trace"`, `"logs"` + +Specifies the format results should be returned as. +#### fn azureTraces.withTraceTypes + +```jsonnet +azureTraces.withTraceTypes(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +#### fn azureTraces.withTraceTypesMixin + +```jsonnet +azureTraces.withTraceTypesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Types of events to filter by. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj grafanaTemplateVariableFn + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsGroupByQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQuery + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withAppInsightsMetricNameQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricDefinitionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +@deprecated Use MetricNamespaceQuery instead +#### fn grafanaTemplateVariableFn.withMetricNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQuery + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withMetricNamespaceQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withMetricNamespaceQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceGroupsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceGroupsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQuery + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withResourceNamesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withResourceNamesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQuery + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withSubscriptionsQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withSubscriptionsQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQuery + +```jsonnet +grafanaTemplateVariableFn.withUnknownQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withUnknownQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withUnknownQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQuery + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn grafanaTemplateVariableFn.withWorkspacesQueryMixin + +```jsonnet +grafanaTemplateVariableFn.withWorkspacesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj grafanaTemplateVariableFn.AppInsightsGroupByQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsGroupByQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.AppInsightsMetricNameQuery + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.AppInsightsMetricNameQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricDefinitionsQuery + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricDefinitionsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamesQuery + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.MetricNamespaceQuery + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withResourceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.MetricNamespaceQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceGroupsQuery + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceGroupsQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.ResourceNamesQuery + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withMetricNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withResourceGroup(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.ResourceNamesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.SubscriptionsQuery + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.SubscriptionsQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.UnknownQuery + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.UnknownQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.UnknownQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj grafanaTemplateVariableFn.WorkspacesQuery + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withKind + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withKind() +``` + + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withRawQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn grafanaTemplateVariableFn.WorkspacesQuery.withSubscription + +```jsonnet +grafanaTemplateVariableFn.WorkspacesQuery.withSubscription(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/index.md new file mode 100644 index 0000000..41482bb --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/index.md @@ -0,0 +1,507 @@ +# bigquery + +grafonnet.query.bigquery + +## Subpackages + +* [sql.columns](sql/columns/index.md) +* [sql.groupBy](sql/groupBy.md) + +## Index + +* [`fn withConvertToUTC(value=true)`](#fn-withconverttoutc) +* [`fn withDataset(value)`](#fn-withdataset) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLocation(value)`](#fn-withlocation) +* [`fn withPartitioned(value=true)`](#fn-withpartitioned) +* [`fn withPartitionedField(value)`](#fn-withpartitionedfield) +* [`fn withProject(value)`](#fn-withproject) +* [`fn withQueryPriority(value)`](#fn-withquerypriority) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawQuery(value=true)`](#fn-withrawquery) +* [`fn withRawSql(value)`](#fn-withrawsql) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSharded(value=true)`](#fn-withsharded) +* [`fn withSql(value)`](#fn-withsql) +* [`fn withSqlMixin(value)`](#fn-withsqlmixin) +* [`fn withTable(value)`](#fn-withtable) +* [`fn withTimeShift(value)`](#fn-withtimeshift) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj sql`](#obj-sql) + * [`fn withColumns(value)`](#fn-sqlwithcolumns) + * [`fn withColumnsMixin(value)`](#fn-sqlwithcolumnsmixin) + * [`fn withFrom(value)`](#fn-sqlwithfrom) + * [`fn withGroupBy(value)`](#fn-sqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-sqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-sqlwithlimit) + * [`fn withOffset(value)`](#fn-sqlwithoffset) + * [`fn withOrderBy(value)`](#fn-sqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-sqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-sqlwithorderbymixin) + * [`fn withWhereString(value)`](#fn-sqlwithwherestring) + * [`obj orderBy`](#obj-sqlorderby) + * [`fn withProperty(value)`](#fn-sqlorderbywithproperty) + * [`fn withPropertyMixin(value)`](#fn-sqlorderbywithpropertymixin) + * [`fn withType()`](#fn-sqlorderbywithtype) + * [`obj property`](#obj-sqlorderbyproperty) + * [`fn withName(value)`](#fn-sqlorderbypropertywithname) + * [`fn withType(value)`](#fn-sqlorderbypropertywithtype) + +## Fields + +### fn withConvertToUTC + +```jsonnet +withConvertToUTC(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withDataset + +```jsonnet +withDataset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLocation + +```jsonnet +withLocation(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPartitioned + +```jsonnet +withPartitioned(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withPartitionedField + +```jsonnet +withPartitionedField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withProject + +```jsonnet +withProject(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQueryPriority + +```jsonnet +withQueryPriority(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"INTERACTIVE"`, `"BATCH"` + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRawQuery + +```jsonnet +withRawQuery(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withRawSql + +```jsonnet +withRawSql(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSharded + +```jsonnet +withSharded(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withSql + +```jsonnet +withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSqlMixin + +```jsonnet +withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withTable + +```jsonnet +withTable(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeShift + +```jsonnet +withTimeShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj sql + + +#### fn sql.withColumns + +```jsonnet +sql.withColumns(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withColumnsMixin + +```jsonnet +sql.withColumnsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withFrom + +```jsonnet +sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn sql.withGroupBy + +```jsonnet +sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withGroupByMixin + +```jsonnet +sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn sql.withLimit + +```jsonnet +sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOffset + +```jsonnet +sql.withOffset(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn sql.withOrderBy + +```jsonnet +sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withOrderByDirection + +```jsonnet +sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"ASC"`, `"DESC"` + + +#### fn sql.withOrderByMixin + +```jsonnet +sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sql.withWhereString + +```jsonnet +sql.withWhereString(value) +``` + +PARAMETERS: + +* **value** (`string`) + +whereJsonTree?: _ +#### obj sql.orderBy + + +##### fn sql.orderBy.withProperty + +```jsonnet +sql.orderBy.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withPropertyMixin + +```jsonnet +sql.orderBy.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn sql.orderBy.withType + +```jsonnet +sql.orderBy.withType() +``` + + + +##### obj sql.orderBy.property + + +###### fn sql.orderBy.property.withName + +```jsonnet +sql.orderBy.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn sql.orderBy.property.withType + +```jsonnet +sql.orderBy.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/index.md new file mode 100644 index 0000000..fe30b54 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/index.md @@ -0,0 +1,57 @@ +# columns + + + +## Subpackages + +* [parameters](parameters.md) + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withParameters(value)`](#fn-withparameters) +* [`fn withParametersMixin(value)`](#fn-withparametersmixin) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withParameters + +```jsonnet +withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withParametersMixin + +```jsonnet +withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/columns/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/groupBy.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/groupBy.md new file mode 100644 index 0000000..d189eb5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/bigquery/sql/groupBy.md @@ -0,0 +1,70 @@ +# groupBy + + + +## Index + +* [`fn withProperty(value)`](#fn-withproperty) +* [`fn withPropertyMixin(value)`](#fn-withpropertymixin) +* [`fn withType()`](#fn-withtype) +* [`obj property`](#obj-property) + * [`fn withName(value)`](#fn-propertywithname) + * [`fn withType(value)`](#fn-propertywithtype) + +## Fields + +### fn withProperty + +```jsonnet +withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPropertyMixin + +```jsonnet +withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withType + +```jsonnet +withType() +``` + + + +### obj property + + +#### fn property.withName + +```jsonnet +property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn property.withType + +```jsonnet +property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md new file mode 100644 index 0000000..a59d777 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchLogsQuery/logGroups.md @@ -0,0 +1,57 @@ +# logGroups + + + +## Index + +* [`fn withAccountId(value)`](#fn-withaccountid) +* [`fn withAccountLabel(value)`](#fn-withaccountlabel) +* [`fn withArn(value)`](#fn-witharn) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withAccountId + +```jsonnet +withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AccountId of the log group +### fn withAccountLabel + +```jsonnet +withAccountLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Label of the log group +### fn withArn + +```jsonnet +withArn(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ARN of the log group +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the log group \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/orderBy/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md new file mode 100644 index 0000000..d2fb19d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/CloudWatchMetricsQuery/sql/select/parameters.md @@ -0,0 +1,29 @@ +# parameters + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withType()`](#fn-withtype) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withType + +```jsonnet +withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/index.md new file mode 100644 index 0000000..9f407a8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/cloudWatch/index.md @@ -0,0 +1,1345 @@ +# cloudWatch + +grafonnet.query.cloudWatch + +## Subpackages + +* [CloudWatchLogsQuery.logGroups](CloudWatchLogsQuery/logGroups.md) +* [CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.parameters](CloudWatchMetricsQuery/sql/from/QueryEditorFunctionExpression/parameters.md) +* [CloudWatchMetricsQuery.sql.orderBy.parameters](CloudWatchMetricsQuery/sql/orderBy/parameters.md) +* [CloudWatchMetricsQuery.sql.select.parameters](CloudWatchMetricsQuery/sql/select/parameters.md) + +## Index + +* [`obj CloudWatchAnnotationQuery`](#obj-cloudwatchannotationquery) + * [`fn withAccountId(value)`](#fn-cloudwatchannotationquerywithaccountid) + * [`fn withActionPrefix(value)`](#fn-cloudwatchannotationquerywithactionprefix) + * [`fn withAlarmNamePrefix(value)`](#fn-cloudwatchannotationquerywithalarmnameprefix) + * [`fn withDatasource(value)`](#fn-cloudwatchannotationquerywithdatasource) + * [`fn withDimensions(value)`](#fn-cloudwatchannotationquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchannotationquerywithdimensionsmixin) + * [`fn withHide(value=true)`](#fn-cloudwatchannotationquerywithhide) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchannotationquerywithmatchexact) + * [`fn withMetricName(value)`](#fn-cloudwatchannotationquerywithmetricname) + * [`fn withNamespace(value)`](#fn-cloudwatchannotationquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchannotationquerywithperiod) + * [`fn withPrefixMatching(value=true)`](#fn-cloudwatchannotationquerywithprefixmatching) + * [`fn withQueryMode(value="Annotations")`](#fn-cloudwatchannotationquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchannotationquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchannotationquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchannotationquerywithregion) + * [`fn withStatistic(value)`](#fn-cloudwatchannotationquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchannotationquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchannotationquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchannotationquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchannotationquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchannotationquerydatasourcewithuid) +* [`obj CloudWatchLogsQuery`](#obj-cloudwatchlogsquery) + * [`fn withDatasource(value)`](#fn-cloudwatchlogsquerywithdatasource) + * [`fn withExpression(value)`](#fn-cloudwatchlogsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchlogsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchlogsquerywithid) + * [`fn withLogGroupNames(value)`](#fn-cloudwatchlogsquerywithloggroupnames) + * [`fn withLogGroupNamesMixin(value)`](#fn-cloudwatchlogsquerywithloggroupnamesmixin) + * [`fn withLogGroups(value)`](#fn-cloudwatchlogsquerywithloggroups) + * [`fn withLogGroupsMixin(value)`](#fn-cloudwatchlogsquerywithloggroupsmixin) + * [`fn withQueryLanguage(value)`](#fn-cloudwatchlogsquerywithquerylanguage) + * [`fn withQueryMode(value="Logs")`](#fn-cloudwatchlogsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchlogsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchlogsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchlogsquerywithregion) + * [`fn withStatsGroups(value)`](#fn-cloudwatchlogsquerywithstatsgroups) + * [`fn withStatsGroupsMixin(value)`](#fn-cloudwatchlogsquerywithstatsgroupsmixin) + * [`obj datasource`](#obj-cloudwatchlogsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchlogsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchlogsquerydatasourcewithuid) +* [`obj CloudWatchMetricsQuery`](#obj-cloudwatchmetricsquery) + * [`fn withAccountId(value)`](#fn-cloudwatchmetricsquerywithaccountid) + * [`fn withAlias(value)`](#fn-cloudwatchmetricsquerywithalias) + * [`fn withDatasource(value)`](#fn-cloudwatchmetricsquerywithdatasource) + * [`fn withDimensions(value)`](#fn-cloudwatchmetricsquerywithdimensions) + * [`fn withDimensionsMixin(value)`](#fn-cloudwatchmetricsquerywithdimensionsmixin) + * [`fn withExpression(value)`](#fn-cloudwatchmetricsquerywithexpression) + * [`fn withHide(value=true)`](#fn-cloudwatchmetricsquerywithhide) + * [`fn withId(value)`](#fn-cloudwatchmetricsquerywithid) + * [`fn withLabel(value)`](#fn-cloudwatchmetricsquerywithlabel) + * [`fn withMatchExact(value=true)`](#fn-cloudwatchmetricsquerywithmatchexact) + * [`fn withMetricEditorMode(value)`](#fn-cloudwatchmetricsquerywithmetriceditormode) + * [`fn withMetricName(value)`](#fn-cloudwatchmetricsquerywithmetricname) + * [`fn withMetricQueryType(value)`](#fn-cloudwatchmetricsquerywithmetricquerytype) + * [`fn withNamespace(value)`](#fn-cloudwatchmetricsquerywithnamespace) + * [`fn withPeriod(value)`](#fn-cloudwatchmetricsquerywithperiod) + * [`fn withQueryMode(value="Metrics")`](#fn-cloudwatchmetricsquerywithquerymode) + * [`fn withQueryType(value)`](#fn-cloudwatchmetricsquerywithquerytype) + * [`fn withRefId(value)`](#fn-cloudwatchmetricsquerywithrefid) + * [`fn withRegion(value)`](#fn-cloudwatchmetricsquerywithregion) + * [`fn withSql(value)`](#fn-cloudwatchmetricsquerywithsql) + * [`fn withSqlExpression(value)`](#fn-cloudwatchmetricsquerywithsqlexpression) + * [`fn withSqlMixin(value)`](#fn-cloudwatchmetricsquerywithsqlmixin) + * [`fn withStatistic(value)`](#fn-cloudwatchmetricsquerywithstatistic) + * [`fn withStatistics(value)`](#fn-cloudwatchmetricsquerywithstatistics) + * [`fn withStatisticsMixin(value)`](#fn-cloudwatchmetricsquerywithstatisticsmixin) + * [`obj datasource`](#obj-cloudwatchmetricsquerydatasource) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerydatasourcewithtype) + * [`fn withUid(value)`](#fn-cloudwatchmetricsquerydatasourcewithuid) + * [`obj sql`](#obj-cloudwatchmetricsquerysql) + * [`fn withFrom(value)`](#fn-cloudwatchmetricsquerysqlwithfrom) + * [`fn withFromMixin(value)`](#fn-cloudwatchmetricsquerysqlwithfrommixin) + * [`fn withGroupBy(value)`](#fn-cloudwatchmetricsquerysqlwithgroupby) + * [`fn withGroupByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithgroupbymixin) + * [`fn withLimit(value)`](#fn-cloudwatchmetricsquerysqlwithlimit) + * [`fn withOrderBy(value)`](#fn-cloudwatchmetricsquerysqlwithorderby) + * [`fn withOrderByDirection(value)`](#fn-cloudwatchmetricsquerysqlwithorderbydirection) + * [`fn withOrderByMixin(value)`](#fn-cloudwatchmetricsquerysqlwithorderbymixin) + * [`fn withSelect(value)`](#fn-cloudwatchmetricsquerysqlwithselect) + * [`fn withSelectMixin(value)`](#fn-cloudwatchmetricsquerysqlwithselectmixin) + * [`fn withWhere(value)`](#fn-cloudwatchmetricsquerysqlwithwhere) + * [`fn withWhereMixin(value)`](#fn-cloudwatchmetricsquerysqlwithwheremixin) + * [`obj from`](#obj-cloudwatchmetricsquerysqlfrom) + * [`fn withQueryEditorFunctionExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpression) + * [`fn withQueryEditorFunctionExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorfunctionexpressionmixin) + * [`fn withQueryEditorPropertyExpression(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpression) + * [`fn withQueryEditorPropertyExpressionMixin(value)`](#fn-cloudwatchmetricsquerysqlfromwithqueryeditorpropertyexpressionmixin) + * [`obj QueryEditorFunctionExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpression) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorfunctionexpressionwithtype) + * [`obj QueryEditorPropertyExpression`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpression) + * [`fn withProperty(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithproperty) + * [`fn withPropertyMixin(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithpropertymixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionwithtype) + * [`obj property`](#obj-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionproperty) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithname) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlfromqueryeditorpropertyexpressionpropertywithtype) + * [`obj groupBy`](#obj-cloudwatchmetricsquerysqlgroupby) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlgroupbywithtype) + * [`obj orderBy`](#obj-cloudwatchmetricsquerysqlorderby) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlorderbywithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlorderbywithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlorderbywithtype) + * [`obj select`](#obj-cloudwatchmetricsquerysqlselect) + * [`fn withName(value)`](#fn-cloudwatchmetricsquerysqlselectwithname) + * [`fn withParameters(value)`](#fn-cloudwatchmetricsquerysqlselectwithparameters) + * [`fn withParametersMixin(value)`](#fn-cloudwatchmetricsquerysqlselectwithparametersmixin) + * [`fn withType()`](#fn-cloudwatchmetricsquerysqlselectwithtype) + * [`obj where`](#obj-cloudwatchmetricsquerysqlwhere) + * [`fn withExpressions(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressions) + * [`fn withExpressionsMixin(value)`](#fn-cloudwatchmetricsquerysqlwherewithexpressionsmixin) + * [`fn withType(value)`](#fn-cloudwatchmetricsquerysqlwherewithtype) + +## Fields + +### obj CloudWatchAnnotationQuery + + +#### fn CloudWatchAnnotationQuery.withAccountId + +```jsonnet +CloudWatchAnnotationQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchAnnotationQuery.withActionPrefix + +```jsonnet +CloudWatchAnnotationQuery.withActionPrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Use this parameter to filter the results of the operation to only those alarms +that use a certain alarm action. For example, you could specify the ARN of +an SNS topic to find all alarms that send notifications to that topic. +e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action` +but not match `arn:aws:sns:us-east-1:123456789012:your-app-action` +#### fn CloudWatchAnnotationQuery.withAlarmNamePrefix + +```jsonnet +CloudWatchAnnotationQuery.withAlarmNamePrefix(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An alarm name prefix. If you specify this parameter, you receive information +about all alarms that have names that start with this prefix. +e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu` +#### fn CloudWatchAnnotationQuery.withDatasource + +```jsonnet +CloudWatchAnnotationQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchAnnotationQuery.withDimensions + +```jsonnet +CloudWatchAnnotationQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withDimensionsMixin + +```jsonnet +CloudWatchAnnotationQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchAnnotationQuery.withHide + +```jsonnet +CloudWatchAnnotationQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchAnnotationQuery.withMatchExact + +```jsonnet +CloudWatchAnnotationQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchAnnotationQuery.withMetricName + +```jsonnet +CloudWatchAnnotationQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchAnnotationQuery.withNamespace + +```jsonnet +CloudWatchAnnotationQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchAnnotationQuery.withPeriod + +```jsonnet +CloudWatchAnnotationQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchAnnotationQuery.withPrefixMatching + +```jsonnet +CloudWatchAnnotationQuery.withPrefixMatching(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix +#### fn CloudWatchAnnotationQuery.withQueryMode + +```jsonnet +CloudWatchAnnotationQuery.withQueryMode(value="Annotations") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Annotations"` + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + +Whether a query is a Metrics, Logs, or Annotations query +#### fn CloudWatchAnnotationQuery.withQueryType + +```jsonnet +CloudWatchAnnotationQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchAnnotationQuery.withRefId + +```jsonnet +CloudWatchAnnotationQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchAnnotationQuery.withRegion + +```jsonnet +CloudWatchAnnotationQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchAnnotationQuery.withStatistic + +```jsonnet +CloudWatchAnnotationQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchAnnotationQuery.withStatistics + +```jsonnet +CloudWatchAnnotationQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchAnnotationQuery.withStatisticsMixin + +```jsonnet +CloudWatchAnnotationQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### obj CloudWatchAnnotationQuery.datasource + + +##### fn CloudWatchAnnotationQuery.datasource.withType + +```jsonnet +CloudWatchAnnotationQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchAnnotationQuery.datasource.withUid + +```jsonnet +CloudWatchAnnotationQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj CloudWatchLogsQuery + + +#### fn CloudWatchLogsQuery.withDatasource + +```jsonnet +CloudWatchLogsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchLogsQuery.withExpression + +```jsonnet +CloudWatchLogsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The CloudWatch Logs Insights query to execute +#### fn CloudWatchLogsQuery.withHide + +```jsonnet +CloudWatchLogsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchLogsQuery.withId + +```jsonnet +CloudWatchLogsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn CloudWatchLogsQuery.withLogGroupNames + +```jsonnet +CloudWatchLogsQuery.withLogGroupNames(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroupNamesMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupNamesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use logGroups +#### fn CloudWatchLogsQuery.withLogGroups + +```jsonnet +CloudWatchLogsQuery.withLogGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withLogGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withLogGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Log groups to query +#### fn CloudWatchLogsQuery.withQueryLanguage + +```jsonnet +CloudWatchLogsQuery.withQueryLanguage(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"CWLI"`, `"SQL"`, `"PPL"` + +Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI. +#### fn CloudWatchLogsQuery.withQueryMode + +```jsonnet +CloudWatchLogsQuery.withQueryMode(value="Logs") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Logs"` + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + +Whether a query is a Metrics, Logs, or Annotations query +#### fn CloudWatchLogsQuery.withQueryType + +```jsonnet +CloudWatchLogsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchLogsQuery.withRefId + +```jsonnet +CloudWatchLogsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchLogsQuery.withRegion + +```jsonnet +CloudWatchLogsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the logs +#### fn CloudWatchLogsQuery.withStatsGroups + +```jsonnet +CloudWatchLogsQuery.withStatsGroups(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +#### fn CloudWatchLogsQuery.withStatsGroupsMixin + +```jsonnet +CloudWatchLogsQuery.withStatsGroupsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Fields to group the results by, this field is automatically populated whenever the query is updated +#### obj CloudWatchLogsQuery.datasource + + +##### fn CloudWatchLogsQuery.datasource.withType + +```jsonnet +CloudWatchLogsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchLogsQuery.datasource.withUid + +```jsonnet +CloudWatchLogsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj CloudWatchMetricsQuery + + +#### fn CloudWatchMetricsQuery.withAccountId + +```jsonnet +CloudWatchMetricsQuery.withAccountId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query. +#### fn CloudWatchMetricsQuery.withAlias + +```jsonnet +CloudWatchMetricsQuery.withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Deprecated: use label +@deprecated use label +#### fn CloudWatchMetricsQuery.withDatasource + +```jsonnet +CloudWatchMetricsQuery.withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +#### fn CloudWatchMetricsQuery.withDimensions + +```jsonnet +CloudWatchMetricsQuery.withDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withDimensionsMixin + +```jsonnet +CloudWatchMetricsQuery.withDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics. +#### fn CloudWatchMetricsQuery.withExpression + +```jsonnet +CloudWatchMetricsQuery.withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Math expression query +#### fn CloudWatchMetricsQuery.withHide + +```jsonnet +CloudWatchMetricsQuery.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +#### fn CloudWatchMetricsQuery.withId + +```jsonnet +CloudWatchMetricsQuery.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter. +#### fn CloudWatchMetricsQuery.withLabel + +```jsonnet +CloudWatchMetricsQuery.withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details. +#### fn CloudWatchMetricsQuery.withMatchExact + +```jsonnet +CloudWatchMetricsQuery.withMatchExact(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Only show metrics that exactly match all defined dimension names. +#### fn CloudWatchMetricsQuery.withMetricEditorMode + +```jsonnet +CloudWatchMetricsQuery.withMetricEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + +Whether to use the query builder or code editor to create the query +#### fn CloudWatchMetricsQuery.withMetricName + +```jsonnet +CloudWatchMetricsQuery.withMetricName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the metric +#### fn CloudWatchMetricsQuery.withMetricQueryType + +```jsonnet +CloudWatchMetricsQuery.withMetricQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `0`, `1` + +Whether to use a metric search or metric insights query +#### fn CloudWatchMetricsQuery.withNamespace + +```jsonnet +CloudWatchMetricsQuery.withNamespace(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace. +#### fn CloudWatchMetricsQuery.withPeriod + +```jsonnet +CloudWatchMetricsQuery.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes +#### fn CloudWatchMetricsQuery.withQueryMode + +```jsonnet +CloudWatchMetricsQuery.withQueryMode(value="Metrics") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"Metrics"` + - valid values: `"Metrics"`, `"Logs"`, `"Annotations"` + +Whether a query is a Metrics, Logs, or Annotations query +#### fn CloudWatchMetricsQuery.withQueryType + +```jsonnet +CloudWatchMetricsQuery.withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +#### fn CloudWatchMetricsQuery.withRefId + +```jsonnet +CloudWatchMetricsQuery.withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +#### fn CloudWatchMetricsQuery.withRegion + +```jsonnet +CloudWatchMetricsQuery.withRegion(value) +``` + +PARAMETERS: + +* **value** (`string`) + +AWS region to query for the metric +#### fn CloudWatchMetricsQuery.withSql + +```jsonnet +CloudWatchMetricsQuery.withSql(value) +``` + +PARAMETERS: + +* **value** (`object`) + +When the metric query type is set to `Insights` and the `metricEditorMode` is set to `Builder`, this field is used to build up an object representation of a SQL query. +#### fn CloudWatchMetricsQuery.withSqlExpression + +```jsonnet +CloudWatchMetricsQuery.withSqlExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +When the metric query type is set to `Insights`, this field is used to specify the query string. +#### fn CloudWatchMetricsQuery.withSqlMixin + +```jsonnet +CloudWatchMetricsQuery.withSqlMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +When the metric query type is set to `Insights` and the `metricEditorMode` is set to `Builder`, this field is used to build up an object representation of a SQL query. +#### fn CloudWatchMetricsQuery.withStatistic + +```jsonnet +CloudWatchMetricsQuery.withStatistic(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html. +#### fn CloudWatchMetricsQuery.withStatistics + +```jsonnet +CloudWatchMetricsQuery.withStatistics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### fn CloudWatchMetricsQuery.withStatisticsMixin + +```jsonnet +CloudWatchMetricsQuery.withStatisticsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +@deprecated use statistic +#### obj CloudWatchMetricsQuery.datasource + + +##### fn CloudWatchMetricsQuery.datasource.withType + +```jsonnet +CloudWatchMetricsQuery.datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +##### fn CloudWatchMetricsQuery.datasource.withUid + +```jsonnet +CloudWatchMetricsQuery.datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +#### obj CloudWatchMetricsQuery.sql + + +##### fn CloudWatchMetricsQuery.sql.withFrom + +```jsonnet +CloudWatchMetricsQuery.sql.withFrom(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withFromMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withFromMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +FROM part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withGroupBy + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +GROUP BY part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withGroupByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +GROUP BY part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withLimit + +```jsonnet +CloudWatchMetricsQuery.sql.withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +LIMIT part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withOrderBy + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`object`) + +ORDER BY part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withOrderByDirection + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByDirection(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The sort order of the SQL expression, `ASC` or `DESC` +##### fn CloudWatchMetricsQuery.sql.withOrderByMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withOrderByMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +ORDER BY part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withSelect + +```jsonnet +CloudWatchMetricsQuery.sql.withSelect(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SELECT part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withSelectMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withSelectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SELECT part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withWhere + +```jsonnet +CloudWatchMetricsQuery.sql.withWhere(value) +``` + +PARAMETERS: + +* **value** (`object`) + +WHERE part of the SQL expression +##### fn CloudWatchMetricsQuery.sql.withWhereMixin + +```jsonnet +CloudWatchMetricsQuery.sql.withWhereMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +WHERE part of the SQL expression +##### obj CloudWatchMetricsQuery.sql.from + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorFunctionExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpression(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### fn CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.withQueryEditorPropertyExpressionMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorFunctionExpression.withType() +``` + + + +###### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withProperty(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withPropertyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +####### fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.withType() +``` + + + +####### obj CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +######## fn CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType + +```jsonnet +CloudWatchMetricsQuery.sql.from.QueryEditorPropertyExpression.property.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"string"` + + +##### obj CloudWatchMetricsQuery.sql.groupBy + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.groupBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.groupBy.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + + +##### obj CloudWatchMetricsQuery.sql.orderBy + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withName + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.orderBy.withType + +```jsonnet +CloudWatchMetricsQuery.sql.orderBy.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.select + + +###### fn CloudWatchMetricsQuery.sql.select.withName + +```jsonnet +CloudWatchMetricsQuery.sql.select.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParameters + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParameters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withParametersMixin + +```jsonnet +CloudWatchMetricsQuery.sql.select.withParametersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.select.withType + +```jsonnet +CloudWatchMetricsQuery.sql.select.withType() +``` + + + +##### obj CloudWatchMetricsQuery.sql.where + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressions + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withExpressionsMixin + +```jsonnet +CloudWatchMetricsQuery.sql.where.withExpressionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn CloudWatchMetricsQuery.sql.where.withType + +```jsonnet +CloudWatchMetricsQuery.sql.where.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"` + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md new file mode 100644 index 0000000..34d2819 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/Filters/settings/filters.md @@ -0,0 +1,32 @@ +# filters + + + +## Index + +* [`fn withLabel(value)`](#fn-withlabel) +* [`fn withQuery(value)`](#fn-withquery) + +## Fields + +### fn withLabel + +```jsonnet +withLabel(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/index.md new file mode 100644 index 0000000..f98cbde --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/bucketAggs/index.md @@ -0,0 +1,567 @@ +# bucketAggs + + + +## Subpackages + +* [Filters.settings.filters](Filters/settings/filters.md) + +## Index + +* [`obj DateHistogram`](#obj-datehistogram) + * [`fn withField(value)`](#fn-datehistogramwithfield) + * [`fn withId(value)`](#fn-datehistogramwithid) + * [`fn withSettings(value)`](#fn-datehistogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-datehistogramwithsettingsmixin) + * [`fn withType()`](#fn-datehistogramwithtype) + * [`obj settings`](#obj-datehistogramsettings) + * [`fn withInterval(value)`](#fn-datehistogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-datehistogramsettingswithmindoccount) + * [`fn withOffset(value)`](#fn-datehistogramsettingswithoffset) + * [`fn withTimeZone(value)`](#fn-datehistogramsettingswithtimezone) + * [`fn withTrimEdges(value)`](#fn-datehistogramsettingswithtrimedges) +* [`obj Filters`](#obj-filters) + * [`fn withId(value)`](#fn-filterswithid) + * [`fn withSettings(value)`](#fn-filterswithsettings) + * [`fn withSettingsMixin(value)`](#fn-filterswithsettingsmixin) + * [`fn withType()`](#fn-filterswithtype) + * [`obj settings`](#obj-filterssettings) + * [`fn withFilters(value)`](#fn-filterssettingswithfilters) + * [`fn withFiltersMixin(value)`](#fn-filterssettingswithfiltersmixin) +* [`obj GeoHashGrid`](#obj-geohashgrid) + * [`fn withField(value)`](#fn-geohashgridwithfield) + * [`fn withId(value)`](#fn-geohashgridwithid) + * [`fn withSettings(value)`](#fn-geohashgridwithsettings) + * [`fn withSettingsMixin(value)`](#fn-geohashgridwithsettingsmixin) + * [`fn withType()`](#fn-geohashgridwithtype) + * [`obj settings`](#obj-geohashgridsettings) + * [`fn withPrecision(value)`](#fn-geohashgridsettingswithprecision) +* [`obj Histogram`](#obj-histogram) + * [`fn withField(value)`](#fn-histogramwithfield) + * [`fn withId(value)`](#fn-histogramwithid) + * [`fn withSettings(value)`](#fn-histogramwithsettings) + * [`fn withSettingsMixin(value)`](#fn-histogramwithsettingsmixin) + * [`fn withType()`](#fn-histogramwithtype) + * [`obj settings`](#obj-histogramsettings) + * [`fn withInterval(value)`](#fn-histogramsettingswithinterval) + * [`fn withMinDocCount(value)`](#fn-histogramsettingswithmindoccount) +* [`obj Nested`](#obj-nested) + * [`fn withField(value)`](#fn-nestedwithfield) + * [`fn withId(value)`](#fn-nestedwithid) + * [`fn withSettings(value)`](#fn-nestedwithsettings) + * [`fn withSettingsMixin(value)`](#fn-nestedwithsettingsmixin) + * [`fn withType()`](#fn-nestedwithtype) +* [`obj Terms`](#obj-terms) + * [`fn withField(value)`](#fn-termswithfield) + * [`fn withId(value)`](#fn-termswithid) + * [`fn withSettings(value)`](#fn-termswithsettings) + * [`fn withSettingsMixin(value)`](#fn-termswithsettingsmixin) + * [`fn withType()`](#fn-termswithtype) + * [`obj settings`](#obj-termssettings) + * [`fn withMinDocCount(value)`](#fn-termssettingswithmindoccount) + * [`fn withMissing(value)`](#fn-termssettingswithmissing) + * [`fn withOrder(value)`](#fn-termssettingswithorder) + * [`fn withOrderBy(value)`](#fn-termssettingswithorderby) + * [`fn withSize(value)`](#fn-termssettingswithsize) + +## Fields + +### obj DateHistogram + + +#### fn DateHistogram.withField + +```jsonnet +DateHistogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withId + +```jsonnet +DateHistogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn DateHistogram.withSettings + +```jsonnet +DateHistogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withSettingsMixin + +```jsonnet +DateHistogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn DateHistogram.withType + +```jsonnet +DateHistogram.withType() +``` + + + +#### obj DateHistogram.settings + + +##### fn DateHistogram.settings.withInterval + +```jsonnet +DateHistogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withMinDocCount + +```jsonnet +DateHistogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withOffset + +```jsonnet +DateHistogram.settings.withOffset(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTimeZone + +```jsonnet +DateHistogram.settings.withTimeZone(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn DateHistogram.settings.withTrimEdges + +```jsonnet +DateHistogram.settings.withTrimEdges(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Filters + + +#### fn Filters.withId + +```jsonnet +Filters.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Filters.withSettings + +```jsonnet +Filters.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withSettingsMixin + +```jsonnet +Filters.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Filters.withType + +```jsonnet +Filters.withType() +``` + + + +#### obj Filters.settings + + +##### fn Filters.settings.withFilters + +```jsonnet +Filters.settings.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn Filters.settings.withFiltersMixin + +```jsonnet +Filters.settings.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj GeoHashGrid + + +#### fn GeoHashGrid.withField + +```jsonnet +GeoHashGrid.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withId + +```jsonnet +GeoHashGrid.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn GeoHashGrid.withSettings + +```jsonnet +GeoHashGrid.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withSettingsMixin + +```jsonnet +GeoHashGrid.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn GeoHashGrid.withType + +```jsonnet +GeoHashGrid.withType() +``` + + + +#### obj GeoHashGrid.settings + + +##### fn GeoHashGrid.settings.withPrecision + +```jsonnet +GeoHashGrid.settings.withPrecision(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Histogram + + +#### fn Histogram.withField + +```jsonnet +Histogram.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withId + +```jsonnet +Histogram.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Histogram.withSettings + +```jsonnet +Histogram.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withSettingsMixin + +```jsonnet +Histogram.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Histogram.withType + +```jsonnet +Histogram.withType() +``` + + + +#### obj Histogram.settings + + +##### fn Histogram.settings.withInterval + +```jsonnet +Histogram.settings.withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Histogram.settings.withMinDocCount + +```jsonnet +Histogram.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj Nested + + +#### fn Nested.withField + +```jsonnet +Nested.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withId + +```jsonnet +Nested.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Nested.withSettings + +```jsonnet +Nested.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withSettingsMixin + +```jsonnet +Nested.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Nested.withType + +```jsonnet +Nested.withType() +``` + + + +### obj Terms + + +#### fn Terms.withField + +```jsonnet +Terms.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withId + +```jsonnet +Terms.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Terms.withSettings + +```jsonnet +Terms.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withSettingsMixin + +```jsonnet +Terms.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn Terms.withType + +```jsonnet +Terms.withType() +``` + + + +#### obj Terms.settings + + +##### fn Terms.settings.withMinDocCount + +```jsonnet +Terms.settings.withMinDocCount(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withMissing + +```jsonnet +Terms.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withOrder + +```jsonnet +Terms.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"desc"`, `"asc"` + + +##### fn Terms.settings.withOrderBy + +```jsonnet +Terms.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn Terms.settings.withSize + +```jsonnet +Terms.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/index.md new file mode 100644 index 0000000..e1b2ed7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/index.md @@ -0,0 +1,178 @@ +# elasticsearch + +grafonnet.query.elasticsearch + +## Subpackages + +* [bucketAggs](bucketAggs/index.md) +* [metrics](metrics/index.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withBucketAggs(value)`](#fn-withbucketaggs) +* [`fn withBucketAggsMixin(value)`](#fn-withbucketaggsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withMetrics(value)`](#fn-withmetrics) +* [`fn withMetricsMixin(value)`](#fn-withmetricsmixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withTimeField(value)`](#fn-withtimefield) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alias pattern +### fn withBucketAggs + +```jsonnet +withBucketAggs(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withBucketAggsMixin + +```jsonnet +withBucketAggsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of bucket aggregations +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withMetrics + +```jsonnet +withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withMetricsMixin + +```jsonnet +withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +List of metric aggregations +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Lucene query +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withTimeField + +```jsonnet +withTimeField(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of time field +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/MetricAggregationWithSettings/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md new file mode 100644 index 0000000..98f8952 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/PipelineMetricAggregation/BucketScript/pipelineVariables.md @@ -0,0 +1,32 @@ +# pipelineVariables + + + +## Index + +* [`fn withName(value)`](#fn-withname) +* [`fn withPipelineAgg(value)`](#fn-withpipelineagg) + +## Fields + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withPipelineAgg + +```jsonnet +withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/index.md new file mode 100644 index 0000000..fc18efe --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/elasticsearch/metrics/index.md @@ -0,0 +1,2547 @@ +# metrics + + + +## Subpackages + +* [MetricAggregationWithSettings.BucketScript.pipelineVariables](MetricAggregationWithSettings/BucketScript/pipelineVariables.md) +* [PipelineMetricAggregation.BucketScript.pipelineVariables](PipelineMetricAggregation/BucketScript/pipelineVariables.md) + +## Index + +* [`obj Count`](#obj-count) + * [`fn withHide(value=true)`](#fn-countwithhide) + * [`fn withId(value)`](#fn-countwithid) + * [`fn withType()`](#fn-countwithtype) +* [`obj MetricAggregationWithSettings`](#obj-metricaggregationwithsettings) + * [`obj Average`](#obj-metricaggregationwithsettingsaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsaveragewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsaveragewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsaveragesettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsaveragesettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsaveragesettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsaveragesettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsaveragesettingsscriptwithinline) + * [`obj BucketScript`](#obj-metricaggregationwithsettingsbucketscript) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsbucketscriptwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsbucketscriptwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsbucketscriptsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-metricaggregationwithsettingscumulativesum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingscumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingscumulativesumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingscumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingscumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingscumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingscumulativesumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingscumulativesumsettings) + * [`fn withFormat(value)`](#fn-metricaggregationwithsettingscumulativesumsettingswithformat) + * [`obj Derivative`](#obj-metricaggregationwithsettingsderivative) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsderivativewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsderivativewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsderivativewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsderivativewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsderivativesettings) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsderivativesettingswithunit) + * [`obj ExtendedStats`](#obj-metricaggregationwithsettingsextendedstats) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsextendedstatswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsextendedstatswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsextendedstatswithid) + * [`fn withMeta(value)`](#fn-metricaggregationwithsettingsextendedstatswithmeta) + * [`fn withMetaMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithmetamixin) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsextendedstatswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsextendedstatswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsextendedstatssettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithscriptmixin) + * [`fn withSigma(value)`](#fn-metricaggregationwithsettingsextendedstatssettingswithsigma) + * [`obj script`](#obj-metricaggregationwithsettingsextendedstatssettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsextendedstatssettingsscriptwithinline) + * [`obj Logs`](#obj-metricaggregationwithsettingslogs) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingslogswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingslogswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingslogswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingslogswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingslogswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingslogssettings) + * [`fn withLimit(value)`](#fn-metricaggregationwithsettingslogssettingswithlimit) + * [`obj Max`](#obj-metricaggregationwithsettingsmax) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmaxwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmaxwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmaxwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmaxwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmaxwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmaxwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmaxsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsmaxsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmaxsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsmaxsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmaxsettingsscriptwithinline) + * [`obj Min`](#obj-metricaggregationwithsettingsmin) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsminwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsminwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsminwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsminwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsminwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsminwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsminsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsminsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsminsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsminsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingsminsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsminsettingsscriptwithinline) + * [`obj MovingAverage`](#obj-metricaggregationwithsettingsmovingaverage) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingaveragewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingaveragewithtype) + * [`obj MovingFunction`](#obj-metricaggregationwithsettingsmovingfunction) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsmovingfunctionwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsmovingfunctionwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsmovingfunctionsettings) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithscriptmixin) + * [`fn withShift(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithshift) + * [`fn withWindow(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingswithwindow) + * [`obj script`](#obj-metricaggregationwithsettingsmovingfunctionsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingsmovingfunctionsettingsscriptwithinline) + * [`obj Percentiles`](#obj-metricaggregationwithsettingspercentiles) + * [`fn withField(value)`](#fn-metricaggregationwithsettingspercentileswithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingspercentileswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingspercentileswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingspercentileswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingspercentileswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingspercentileswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingspercentilessettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingspercentilessettingswithmissing) + * [`fn withPercents(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercents) + * [`fn withPercentsMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithpercentsmixin) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingspercentilessettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingspercentilessettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingspercentilessettingsscriptwithinline) + * [`obj Rate`](#obj-metricaggregationwithsettingsrate) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsratewithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsratewithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsratewithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsratewithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsratewithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsratewithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsratesettings) + * [`fn withMode(value)`](#fn-metricaggregationwithsettingsratesettingswithmode) + * [`fn withUnit(value)`](#fn-metricaggregationwithsettingsratesettingswithunit) + * [`obj RawData`](#obj-metricaggregationwithsettingsrawdata) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdatawithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdatawithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdatawithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdatawithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdatawithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdatasettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdatasettingswithsize) + * [`obj RawDocument`](#obj-metricaggregationwithsettingsrawdocument) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsrawdocumentwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsrawdocumentwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsrawdocumentwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsrawdocumentwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsrawdocumentsettings) + * [`fn withSize(value)`](#fn-metricaggregationwithsettingsrawdocumentsettingswithsize) + * [`obj SerialDiff`](#obj-metricaggregationwithsettingsserialdiff) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsserialdiffwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsserialdiffwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsserialdiffwithid) + * [`fn withPipelineAgg(value)`](#fn-metricaggregationwithsettingsserialdiffwithpipelineagg) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsserialdiffwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsserialdiffwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsserialdiffsettings) + * [`fn withLag(value)`](#fn-metricaggregationwithsettingsserialdiffsettingswithlag) + * [`obj Sum`](#obj-metricaggregationwithsettingssum) + * [`fn withField(value)`](#fn-metricaggregationwithsettingssumwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingssumwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingssumwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingssumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingssumwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingssumwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingssumsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingssumsettingswithmissing) + * [`fn withScript(value)`](#fn-metricaggregationwithsettingssumsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-metricaggregationwithsettingssumsettingswithscriptmixin) + * [`obj script`](#obj-metricaggregationwithsettingssumsettingsscript) + * [`fn withInline(value)`](#fn-metricaggregationwithsettingssumsettingsscriptwithinline) + * [`obj TopMetrics`](#obj-metricaggregationwithsettingstopmetrics) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingstopmetricswithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingstopmetricswithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingstopmetricswithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingstopmetricswithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingstopmetricswithtype) + * [`obj settings`](#obj-metricaggregationwithsettingstopmetricssettings) + * [`fn withMetrics(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetrics) + * [`fn withMetricsMixin(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithmetricsmixin) + * [`fn withOrder(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorder) + * [`fn withOrderBy(value)`](#fn-metricaggregationwithsettingstopmetricssettingswithorderby) + * [`obj UniqueCount`](#obj-metricaggregationwithsettingsuniquecount) + * [`fn withField(value)`](#fn-metricaggregationwithsettingsuniquecountwithfield) + * [`fn withHide(value=true)`](#fn-metricaggregationwithsettingsuniquecountwithhide) + * [`fn withId(value)`](#fn-metricaggregationwithsettingsuniquecountwithid) + * [`fn withSettings(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettings) + * [`fn withSettingsMixin(value)`](#fn-metricaggregationwithsettingsuniquecountwithsettingsmixin) + * [`fn withType()`](#fn-metricaggregationwithsettingsuniquecountwithtype) + * [`obj settings`](#obj-metricaggregationwithsettingsuniquecountsettings) + * [`fn withMissing(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithmissing) + * [`fn withPrecisionThreshold(value)`](#fn-metricaggregationwithsettingsuniquecountsettingswithprecisionthreshold) +* [`obj PipelineMetricAggregation`](#obj-pipelinemetricaggregation) + * [`obj BucketScript`](#obj-pipelinemetricaggregationbucketscript) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationbucketscriptwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationbucketscriptwithid) + * [`fn withPipelineVariables(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariables) + * [`fn withPipelineVariablesMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithpipelinevariablesmixin) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationbucketscriptwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationbucketscriptwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationbucketscriptsettings) + * [`fn withScript(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscript) + * [`fn withScriptMixin(value)`](#fn-pipelinemetricaggregationbucketscriptsettingswithscriptmixin) + * [`obj script`](#obj-pipelinemetricaggregationbucketscriptsettingsscript) + * [`fn withInline(value)`](#fn-pipelinemetricaggregationbucketscriptsettingsscriptwithinline) + * [`obj CumulativeSum`](#obj-pipelinemetricaggregationcumulativesum) + * [`fn withField(value)`](#fn-pipelinemetricaggregationcumulativesumwithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationcumulativesumwithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationcumulativesumwithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationcumulativesumwithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationcumulativesumwithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationcumulativesumwithtype) + * [`obj settings`](#obj-pipelinemetricaggregationcumulativesumsettings) + * [`fn withFormat(value)`](#fn-pipelinemetricaggregationcumulativesumsettingswithformat) + * [`obj Derivative`](#obj-pipelinemetricaggregationderivative) + * [`fn withField(value)`](#fn-pipelinemetricaggregationderivativewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationderivativewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationderivativewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationderivativewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationderivativewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationderivativewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationderivativewithtype) + * [`obj settings`](#obj-pipelinemetricaggregationderivativesettings) + * [`fn withUnit(value)`](#fn-pipelinemetricaggregationderivativesettingswithunit) + * [`obj MovingAverage`](#obj-pipelinemetricaggregationmovingaverage) + * [`fn withField(value)`](#fn-pipelinemetricaggregationmovingaveragewithfield) + * [`fn withHide(value=true)`](#fn-pipelinemetricaggregationmovingaveragewithhide) + * [`fn withId(value)`](#fn-pipelinemetricaggregationmovingaveragewithid) + * [`fn withPipelineAgg(value)`](#fn-pipelinemetricaggregationmovingaveragewithpipelineagg) + * [`fn withSettings(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettings) + * [`fn withSettingsMixin(value)`](#fn-pipelinemetricaggregationmovingaveragewithsettingsmixin) + * [`fn withType()`](#fn-pipelinemetricaggregationmovingaveragewithtype) + +## Fields + +### obj Count + + +#### fn Count.withHide + +```jsonnet +Count.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn Count.withId + +```jsonnet +Count.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn Count.withType + +```jsonnet +Count.withType() +``` + + + +### obj MetricAggregationWithSettings + + +#### obj MetricAggregationWithSettings.Average + + +##### fn MetricAggregationWithSettings.Average.withField + +```jsonnet +MetricAggregationWithSettings.Average.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withHide + +```jsonnet +MetricAggregationWithSettings.Average.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Average.withId + +```jsonnet +MetricAggregationWithSettings.Average.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Average.withSettings + +```jsonnet +MetricAggregationWithSettings.Average.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Average.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Average.withType + +```jsonnet +MetricAggregationWithSettings.Average.withType() +``` + + + +##### obj MetricAggregationWithSettings.Average.settings + + +###### fn MetricAggregationWithSettings.Average.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Average.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Average.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Average.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Average.settings.script + + +####### fn MetricAggregationWithSettings.Average.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Average.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.BucketScript + + +##### fn MetricAggregationWithSettings.BucketScript.withHide + +```jsonnet +MetricAggregationWithSettings.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.BucketScript.withId + +```jsonnet +MetricAggregationWithSettings.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariables + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettings + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.BucketScript.withType + +```jsonnet +MetricAggregationWithSettings.BucketScript.withType() +``` + + + +##### obj MetricAggregationWithSettings.BucketScript.settings + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScript + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.BucketScript.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.BucketScript.settings.script + + +####### fn MetricAggregationWithSettings.BucketScript.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.CumulativeSum + + +##### fn MetricAggregationWithSettings.CumulativeSum.withField + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withHide + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.CumulativeSum.withId + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettings + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.CumulativeSum.withType + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.withType() +``` + + + +##### obj MetricAggregationWithSettings.CumulativeSum.settings + + +###### fn MetricAggregationWithSettings.CumulativeSum.settings.withFormat + +```jsonnet +MetricAggregationWithSettings.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Derivative + + +##### fn MetricAggregationWithSettings.Derivative.withField + +```jsonnet +MetricAggregationWithSettings.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withHide + +```jsonnet +MetricAggregationWithSettings.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Derivative.withId + +```jsonnet +MetricAggregationWithSettings.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettings + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Derivative.withType + +```jsonnet +MetricAggregationWithSettings.Derivative.withType() +``` + + + +##### obj MetricAggregationWithSettings.Derivative.settings + + +###### fn MetricAggregationWithSettings.Derivative.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.ExtendedStats + + +##### fn MetricAggregationWithSettings.ExtendedStats.withField + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withHide + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.ExtendedStats.withId + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMeta + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMeta(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withMetaMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withMetaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettings + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.ExtendedStats.withType + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.withType() +``` + + + +##### obj MetricAggregationWithSettings.ExtendedStats.settings + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScript + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.ExtendedStats.settings.withSigma + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.withSigma(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.ExtendedStats.settings.script + + +####### fn MetricAggregationWithSettings.ExtendedStats.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.ExtendedStats.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Logs + + +##### fn MetricAggregationWithSettings.Logs.withHide + +```jsonnet +MetricAggregationWithSettings.Logs.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Logs.withId + +```jsonnet +MetricAggregationWithSettings.Logs.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Logs.withSettings + +```jsonnet +MetricAggregationWithSettings.Logs.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Logs.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Logs.withType + +```jsonnet +MetricAggregationWithSettings.Logs.withType() +``` + + + +##### obj MetricAggregationWithSettings.Logs.settings + + +###### fn MetricAggregationWithSettings.Logs.settings.withLimit + +```jsonnet +MetricAggregationWithSettings.Logs.settings.withLimit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Max + + +##### fn MetricAggregationWithSettings.Max.withField + +```jsonnet +MetricAggregationWithSettings.Max.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withHide + +```jsonnet +MetricAggregationWithSettings.Max.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Max.withId + +```jsonnet +MetricAggregationWithSettings.Max.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Max.withSettings + +```jsonnet +MetricAggregationWithSettings.Max.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Max.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Max.withType + +```jsonnet +MetricAggregationWithSettings.Max.withType() +``` + + + +##### obj MetricAggregationWithSettings.Max.settings + + +###### fn MetricAggregationWithSettings.Max.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Max.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Max.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Max.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Max.settings.script + + +####### fn MetricAggregationWithSettings.Max.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Max.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Min + + +##### fn MetricAggregationWithSettings.Min.withField + +```jsonnet +MetricAggregationWithSettings.Min.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withHide + +```jsonnet +MetricAggregationWithSettings.Min.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Min.withId + +```jsonnet +MetricAggregationWithSettings.Min.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Min.withSettings + +```jsonnet +MetricAggregationWithSettings.Min.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Min.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Min.withType + +```jsonnet +MetricAggregationWithSettings.Min.withType() +``` + + + +##### obj MetricAggregationWithSettings.Min.settings + + +###### fn MetricAggregationWithSettings.Min.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Min.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Min.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Min.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Min.settings.script + + +####### fn MetricAggregationWithSettings.Min.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Min.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.MovingAverage + + +##### fn MetricAggregationWithSettings.MovingAverage.withField + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withHide + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingAverage.withId + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingAverage.withType + +```jsonnet +MetricAggregationWithSettings.MovingAverage.withType() +``` + + + +#### obj MetricAggregationWithSettings.MovingFunction + + +##### fn MetricAggregationWithSettings.MovingFunction.withField + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withHide + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.MovingFunction.withId + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettings + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.MovingFunction.withType + +```jsonnet +MetricAggregationWithSettings.MovingFunction.withType() +``` + + + +##### obj MetricAggregationWithSettings.MovingFunction.settings + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScript + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withShift + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withShift(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.MovingFunction.settings.withWindow + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### obj MetricAggregationWithSettings.MovingFunction.settings.script + + +####### fn MetricAggregationWithSettings.MovingFunction.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.MovingFunction.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Percentiles + + +##### fn MetricAggregationWithSettings.Percentiles.withField + +```jsonnet +MetricAggregationWithSettings.Percentiles.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withHide + +```jsonnet +MetricAggregationWithSettings.Percentiles.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Percentiles.withId + +```jsonnet +MetricAggregationWithSettings.Percentiles.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettings + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Percentiles.withType + +```jsonnet +MetricAggregationWithSettings.Percentiles.withType() +``` + + + +##### obj MetricAggregationWithSettings.Percentiles.settings + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercents + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercents(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withPercentsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Percentiles.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Percentiles.settings.script + + +####### fn MetricAggregationWithSettings.Percentiles.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Percentiles.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Rate + + +##### fn MetricAggregationWithSettings.Rate.withField + +```jsonnet +MetricAggregationWithSettings.Rate.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withHide + +```jsonnet +MetricAggregationWithSettings.Rate.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Rate.withId + +```jsonnet +MetricAggregationWithSettings.Rate.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Rate.withSettings + +```jsonnet +MetricAggregationWithSettings.Rate.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Rate.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Rate.withType + +```jsonnet +MetricAggregationWithSettings.Rate.withType() +``` + + + +##### obj MetricAggregationWithSettings.Rate.settings + + +###### fn MetricAggregationWithSettings.Rate.settings.withMode + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Rate.settings.withUnit + +```jsonnet +MetricAggregationWithSettings.Rate.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawData + + +##### fn MetricAggregationWithSettings.RawData.withHide + +```jsonnet +MetricAggregationWithSettings.RawData.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawData.withId + +```jsonnet +MetricAggregationWithSettings.RawData.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawData.withSettings + +```jsonnet +MetricAggregationWithSettings.RawData.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawData.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawData.withType + +```jsonnet +MetricAggregationWithSettings.RawData.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawData.settings + + +###### fn MetricAggregationWithSettings.RawData.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawData.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.RawDocument + + +##### fn MetricAggregationWithSettings.RawDocument.withHide + +```jsonnet +MetricAggregationWithSettings.RawDocument.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.RawDocument.withId + +```jsonnet +MetricAggregationWithSettings.RawDocument.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettings + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.RawDocument.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.RawDocument.withType + +```jsonnet +MetricAggregationWithSettings.RawDocument.withType() +``` + + + +##### obj MetricAggregationWithSettings.RawDocument.settings + + +###### fn MetricAggregationWithSettings.RawDocument.settings.withSize + +```jsonnet +MetricAggregationWithSettings.RawDocument.settings.withSize(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.SerialDiff + + +##### fn MetricAggregationWithSettings.SerialDiff.withField + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withHide + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.SerialDiff.withId + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withPipelineAgg + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettings + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.SerialDiff.withType + +```jsonnet +MetricAggregationWithSettings.SerialDiff.withType() +``` + + + +##### obj MetricAggregationWithSettings.SerialDiff.settings + + +###### fn MetricAggregationWithSettings.SerialDiff.settings.withLag + +```jsonnet +MetricAggregationWithSettings.SerialDiff.settings.withLag(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.Sum + + +##### fn MetricAggregationWithSettings.Sum.withField + +```jsonnet +MetricAggregationWithSettings.Sum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withHide + +```jsonnet +MetricAggregationWithSettings.Sum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.Sum.withId + +```jsonnet +MetricAggregationWithSettings.Sum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.Sum.withSettings + +```jsonnet +MetricAggregationWithSettings.Sum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.Sum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.Sum.withType + +```jsonnet +MetricAggregationWithSettings.Sum.withType() +``` + + + +##### obj MetricAggregationWithSettings.Sum.settings + + +###### fn MetricAggregationWithSettings.Sum.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScript + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn MetricAggregationWithSettings.Sum.settings.withScriptMixin + +```jsonnet +MetricAggregationWithSettings.Sum.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj MetricAggregationWithSettings.Sum.settings.script + + +####### fn MetricAggregationWithSettings.Sum.settings.script.withInline + +```jsonnet +MetricAggregationWithSettings.Sum.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.TopMetrics + + +##### fn MetricAggregationWithSettings.TopMetrics.withHide + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.TopMetrics.withId + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettings + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.TopMetrics.withType + +```jsonnet +MetricAggregationWithSettings.TopMetrics.withType() +``` + + + +##### obj MetricAggregationWithSettings.TopMetrics.settings + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetrics + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetrics(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withMetricsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrder + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrder(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.TopMetrics.settings.withOrderBy + +```jsonnet +MetricAggregationWithSettings.TopMetrics.settings.withOrderBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj MetricAggregationWithSettings.UniqueCount + + +##### fn MetricAggregationWithSettings.UniqueCount.withField + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withHide + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn MetricAggregationWithSettings.UniqueCount.withId + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettings + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withSettingsMixin + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn MetricAggregationWithSettings.UniqueCount.withType + +```jsonnet +MetricAggregationWithSettings.UniqueCount.withType() +``` + + + +##### obj MetricAggregationWithSettings.UniqueCount.settings + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withMissing + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withMissing(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +###### fn MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold + +```jsonnet +MetricAggregationWithSettings.UniqueCount.settings.withPrecisionThreshold(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj PipelineMetricAggregation + + +#### obj PipelineMetricAggregation.BucketScript + + +##### fn PipelineMetricAggregation.BucketScript.withHide + +```jsonnet +PipelineMetricAggregation.BucketScript.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.BucketScript.withId + +```jsonnet +PipelineMetricAggregation.BucketScript.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariables + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariables(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withPipelineVariablesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettings + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.BucketScript.withType + +```jsonnet +PipelineMetricAggregation.BucketScript.withType() +``` + + + +##### obj PipelineMetricAggregation.BucketScript.settings + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScript + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScript(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### fn PipelineMetricAggregation.BucketScript.settings.withScriptMixin + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.withScriptMixin(value) +``` + +PARAMETERS: + +* **value** (`object`,`string`) + + +###### obj PipelineMetricAggregation.BucketScript.settings.script + + +####### fn PipelineMetricAggregation.BucketScript.settings.script.withInline + +```jsonnet +PipelineMetricAggregation.BucketScript.settings.script.withInline(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.CumulativeSum + + +##### fn PipelineMetricAggregation.CumulativeSum.withField + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withHide + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.CumulativeSum.withId + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettings + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.CumulativeSum.withType + +```jsonnet +PipelineMetricAggregation.CumulativeSum.withType() +``` + + + +##### obj PipelineMetricAggregation.CumulativeSum.settings + + +###### fn PipelineMetricAggregation.CumulativeSum.settings.withFormat + +```jsonnet +PipelineMetricAggregation.CumulativeSum.settings.withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.Derivative + + +##### fn PipelineMetricAggregation.Derivative.withField + +```jsonnet +PipelineMetricAggregation.Derivative.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withHide + +```jsonnet +PipelineMetricAggregation.Derivative.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.Derivative.withId + +```jsonnet +PipelineMetricAggregation.Derivative.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.Derivative.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.Derivative.withSettings + +```jsonnet +PipelineMetricAggregation.Derivative.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.Derivative.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.Derivative.withType + +```jsonnet +PipelineMetricAggregation.Derivative.withType() +``` + + + +##### obj PipelineMetricAggregation.Derivative.settings + + +###### fn PipelineMetricAggregation.Derivative.settings.withUnit + +```jsonnet +PipelineMetricAggregation.Derivative.settings.withUnit(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### obj PipelineMetricAggregation.MovingAverage + + +##### fn PipelineMetricAggregation.MovingAverage.withField + +```jsonnet +PipelineMetricAggregation.MovingAverage.withField(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withHide + +```jsonnet +PipelineMetricAggregation.MovingAverage.withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +##### fn PipelineMetricAggregation.MovingAverage.withId + +```jsonnet +PipelineMetricAggregation.MovingAverage.withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withPipelineAgg + +```jsonnet +PipelineMetricAggregation.MovingAverage.withPipelineAgg(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettings + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withSettingsMixin + +```jsonnet +PipelineMetricAggregation.MovingAverage.withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +##### fn PipelineMetricAggregation.MovingAverage.withType + +```jsonnet +PipelineMetricAggregation.MovingAverage.withType() +``` + + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/conditions.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/conditions.md new file mode 100644 index 0000000..ec5853e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/conditions.md @@ -0,0 +1,205 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withOperatorMixin(value)`](#fn-withoperatormixin) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryMixin(value)`](#fn-withquerymixin) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withReducerMixin(value)`](#fn-withreducermixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj operator`](#obj-operator) + * [`fn withType(value)`](#fn-operatorwithtype) +* [`obj query`](#obj-query) + * [`fn withParams(value)`](#fn-querywithparams) + * [`fn withParamsMixin(value)`](#fn-querywithparamsmixin) +* [`obj reducer`](#obj-reducer) + * [`fn withType(value)`](#fn-reducerwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withOperatorMixin + +```jsonnet +withOperatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryMixin + +```jsonnet +withQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withReducerMixin + +```jsonnet +withReducerMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +e.g. "gt" +### obj operator + + +#### fn operator.withType + +```jsonnet +operator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"and"`, `"or"`, `"logic-or"` + + +### obj query + + +#### fn query.withParams + +```jsonnet +query.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn query.withParamsMixin + +```jsonnet +query.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### obj reducer + + +#### fn reducer.withType + +```jsonnet +reducer.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/index.md new file mode 100644 index 0000000..7d57eca --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeClassicConditions/index.md @@ -0,0 +1,315 @@ +# TypeClassicConditions + +grafonnet.query.expr.TypeClassicConditions + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeMath.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeMath.md new file mode 100644 index 0000000..5cdd604 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeMath.md @@ -0,0 +1,299 @@ +# TypeMath + +grafonnet.query.expr.TypeMath + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +General math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeReduce.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeReduce.md new file mode 100644 index 0000000..1caafbd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeReduce.md @@ -0,0 +1,376 @@ +# TypeReduce + +grafonnet.query.expr.TypeReduce + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withReducer(value)`](#fn-withreducer) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withSettings(value)`](#fn-withsettings) +* [`fn withSettingsMixin(value)`](#fn-withsettingsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj settings`](#obj-settings) + * [`fn withMode(value)`](#fn-settingswithmode) + * [`fn withReplaceWithValue(value)`](#fn-settingswithreplacewithvalue) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withReducer + +```jsonnet +withReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"`, `"median"` + +The reducer +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` + - `"median"` +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withSettings + +```jsonnet +withSettings(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withSettingsMixin + +```jsonnet +withSettingsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Reducer Options +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj settings + + +#### fn settings.withMode + +```jsonnet +settings.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"dropNN"`, `"replaceNN"` + +Non-number reduce behavior +Possible enum values: + - `"dropNN"` Drop non-numbers + - `"replaceNN"` Replace non-numbers +#### fn settings.withReplaceWithValue + +```jsonnet +settings.withReplaceWithValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Only valid when mode is replace +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeResample.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeResample.md new file mode 100644 index 0000000..447283f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeResample.md @@ -0,0 +1,349 @@ +# TypeResample + +grafonnet.query.expr.TypeResample + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withDownsampler(value)`](#fn-withdownsampler) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`fn withUpsampler(value)`](#fn-withupsampler) +* [`fn withWindow(value)`](#fn-withwindow) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDownsampler + +```jsonnet +withDownsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"sum"`, `"mean"`, `"min"`, `"max"`, `"count"`, `"last"`, `"median"` + +The downsample function +Possible enum values: + - `"sum"` + - `"mean"` + - `"min"` + - `"max"` + - `"count"` + - `"last"` + - `"median"` +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The math expression +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### fn withUpsampler + +```jsonnet +withUpsampler(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"pad"`, `"backfilling"`, `"fillna"` + +The upsample function +Possible enum values: + - `"pad"` Use the last seen value + - `"backfilling"` backfill + - `"fillna"` Do not fill values (nill) +### fn withWindow + +```jsonnet +withWindow(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The time duration +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeSql.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeSql.md new file mode 100644 index 0000000..ac71f3e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeSql.md @@ -0,0 +1,299 @@ +# TypeSql + +grafonnet.query.expr.TypeSql + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/conditions.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/conditions.md new file mode 100644 index 0000000..554ddb9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/conditions.md @@ -0,0 +1,163 @@ +# conditions + + + +## Index + +* [`fn withEvaluator(value)`](#fn-withevaluator) +* [`fn withEvaluatorMixin(value)`](#fn-withevaluatormixin) +* [`fn withLoadedDimensions(value)`](#fn-withloadeddimensions) +* [`fn withLoadedDimensionsMixin(value)`](#fn-withloadeddimensionsmixin) +* [`fn withUnloadEvaluator(value)`](#fn-withunloadevaluator) +* [`fn withUnloadEvaluatorMixin(value)`](#fn-withunloadevaluatormixin) +* [`obj evaluator`](#obj-evaluator) + * [`fn withParams(value)`](#fn-evaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-evaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-evaluatorwithtype) +* [`obj unloadEvaluator`](#obj-unloadevaluator) + * [`fn withParams(value)`](#fn-unloadevaluatorwithparams) + * [`fn withParamsMixin(value)`](#fn-unloadevaluatorwithparamsmixin) + * [`fn withType(value)`](#fn-unloadevaluatorwithtype) + +## Fields + +### fn withEvaluator + +```jsonnet +withEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withEvaluatorMixin + +```jsonnet +withEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensions + +```jsonnet +withLoadedDimensions(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withLoadedDimensionsMixin + +```jsonnet +withLoadedDimensionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluator + +```jsonnet +withUnloadEvaluator(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUnloadEvaluatorMixin + +```jsonnet +withUnloadEvaluatorMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### obj evaluator + + +#### fn evaluator.withParams + +```jsonnet +evaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withParamsMixin + +```jsonnet +evaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn evaluator.withType + +```jsonnet +evaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" +### obj unloadEvaluator + + +#### fn unloadEvaluator.withParams + +```jsonnet +unloadEvaluator.withParams(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withParamsMixin + +```jsonnet +unloadEvaluator.withParamsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn unloadEvaluator.withType + +```jsonnet +unloadEvaluator.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"gt"`, `"lt"`, `"within_range"`, `"outside_range"` + +e.g. "gt" \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/index.md new file mode 100644 index 0000000..9d5783c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/TypeThreshold/index.md @@ -0,0 +1,327 @@ +# TypeThreshold + +grafonnet.query.expr.TypeThreshold + +## Subpackages + +* [conditions](conditions.md) + +## Index + +* [`fn withConditions(value)`](#fn-withconditions) +* [`fn withConditionsMixin(value)`](#fn-withconditionsmixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDatasourceMixin(value)`](#fn-withdatasourcemixin) +* [`fn withExpression(value)`](#fn-withexpression) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withType()`](#fn-withtype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) + +## Fields + +### fn withConditions + +```jsonnet +withConditions(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withConditionsMixin + +```jsonnet +withConditionsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Threshold Conditions +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withDatasourceMixin + +```jsonnet +withDatasourceMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Ref to a DataSource instance +### fn withExpression + +```jsonnet +withExpression(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reference to single query result +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withType + +```jsonnet +withType() +``` + + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/index.md new file mode 100644 index 0000000..a89a72a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/expr/index.md @@ -0,0 +1,12 @@ +# expr + +Server Side Expression operations for grafonnet.alerting.ruleGroup.rule + +## Subpackages + +* [TypeClassicConditions](TypeClassicConditions/index.md) +* [TypeMath](TypeMath.md) +* [TypeReduce](TypeReduce.md) +* [TypeResample](TypeResample.md) +* [TypeSql](TypeSql.md) +* [TypeThreshold](TypeThreshold/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/googleCloudMonitoring.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/googleCloudMonitoring.md new file mode 100644 index 0000000..bdd9c76 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/googleCloudMonitoring.md @@ -0,0 +1,623 @@ +# googleCloudMonitoring + +grafonnet.query.googleCloudMonitoring + +## Index + +* [`fn withAliasBy(value)`](#fn-withaliasby) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withPromQLQuery(value)`](#fn-withpromqlquery) +* [`fn withPromQLQueryMixin(value)`](#fn-withpromqlquerymixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSloQuery(value)`](#fn-withsloquery) +* [`fn withSloQueryMixin(value)`](#fn-withsloquerymixin) +* [`fn withTimeSeriesList(value)`](#fn-withtimeserieslist) +* [`fn withTimeSeriesListMixin(value)`](#fn-withtimeserieslistmixin) +* [`fn withTimeSeriesQuery(value)`](#fn-withtimeseriesquery) +* [`fn withTimeSeriesQueryMixin(value)`](#fn-withtimeseriesquerymixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj promQLQuery`](#obj-promqlquery) + * [`fn withExpr(value)`](#fn-promqlquerywithexpr) + * [`fn withProjectName(value)`](#fn-promqlquerywithprojectname) + * [`fn withStep(value)`](#fn-promqlquerywithstep) +* [`obj sloQuery`](#obj-sloquery) + * [`fn withAlignmentPeriod(value)`](#fn-sloquerywithalignmentperiod) + * [`fn withGoal(value)`](#fn-sloquerywithgoal) + * [`fn withLookbackPeriod(value)`](#fn-sloquerywithlookbackperiod) + * [`fn withPerSeriesAligner(value)`](#fn-sloquerywithperseriesaligner) + * [`fn withProjectName(value)`](#fn-sloquerywithprojectname) + * [`fn withSelectorName(value)`](#fn-sloquerywithselectorname) + * [`fn withServiceId(value)`](#fn-sloquerywithserviceid) + * [`fn withServiceName(value)`](#fn-sloquerywithservicename) + * [`fn withSloId(value)`](#fn-sloquerywithsloid) + * [`fn withSloName(value)`](#fn-sloquerywithsloname) +* [`obj timeSeriesList`](#obj-timeserieslist) + * [`fn withAlignmentPeriod(value)`](#fn-timeserieslistwithalignmentperiod) + * [`fn withCrossSeriesReducer(value)`](#fn-timeserieslistwithcrossseriesreducer) + * [`fn withFilters(value)`](#fn-timeserieslistwithfilters) + * [`fn withFiltersMixin(value)`](#fn-timeserieslistwithfiltersmixin) + * [`fn withGroupBys(value)`](#fn-timeserieslistwithgroupbys) + * [`fn withGroupBysMixin(value)`](#fn-timeserieslistwithgroupbysmixin) + * [`fn withPerSeriesAligner(value)`](#fn-timeserieslistwithperseriesaligner) + * [`fn withPreprocessor(value)`](#fn-timeserieslistwithpreprocessor) + * [`fn withProjectName(value)`](#fn-timeserieslistwithprojectname) + * [`fn withSecondaryAlignmentPeriod(value)`](#fn-timeserieslistwithsecondaryalignmentperiod) + * [`fn withSecondaryCrossSeriesReducer(value)`](#fn-timeserieslistwithsecondarycrossseriesreducer) + * [`fn withSecondaryGroupBys(value)`](#fn-timeserieslistwithsecondarygroupbys) + * [`fn withSecondaryGroupBysMixin(value)`](#fn-timeserieslistwithsecondarygroupbysmixin) + * [`fn withSecondaryPerSeriesAligner(value)`](#fn-timeserieslistwithsecondaryperseriesaligner) + * [`fn withText(value)`](#fn-timeserieslistwithtext) + * [`fn withTitle(value)`](#fn-timeserieslistwithtitle) + * [`fn withView(value)`](#fn-timeserieslistwithview) +* [`obj timeSeriesQuery`](#obj-timeseriesquery) + * [`fn withGraphPeriod(value="disabled")`](#fn-timeseriesquerywithgraphperiod) + * [`fn withProjectName(value)`](#fn-timeseriesquerywithprojectname) + * [`fn withQuery(value)`](#fn-timeseriesquerywithquery) + +## Fields + +### fn withAliasBy + +```jsonnet +withAliasBy(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Time interval in milliseconds. +### fn withPromQLQuery + +```jsonnet +withPromQLQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withPromQLQueryMixin + +```jsonnet +withPromQLQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +PromQL sub-query properties. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSloQuery + +```jsonnet +withSloQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withSloQueryMixin + +```jsonnet +withSloQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +SLO sub-query properties. +### fn withTimeSeriesList + +```jsonnet +withTimeSeriesList(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesListMixin + +```jsonnet +withTimeSeriesListMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series List sub-query properties. +### fn withTimeSeriesQuery + +```jsonnet +withTimeSeriesQuery(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### fn withTimeSeriesQueryMixin + +```jsonnet +withTimeSeriesQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Time Series sub-query properties. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj promQLQuery + + +#### fn promQLQuery.withExpr + +```jsonnet +promQLQuery.withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL expression/query to be executed. +#### fn promQLQuery.withProjectName + +```jsonnet +promQLQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn promQLQuery.withStep + +```jsonnet +promQLQuery.withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +PromQL min step +### obj sloQuery + + +#### fn sloQuery.withAlignmentPeriod + +```jsonnet +sloQuery.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn sloQuery.withGoal + +```jsonnet +sloQuery.withGoal(value) +``` + +PARAMETERS: + +* **value** (`number`) + +SLO goal value. +#### fn sloQuery.withLookbackPeriod + +```jsonnet +sloQuery.withLookbackPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific lookback period for the SLO. +#### fn sloQuery.withPerSeriesAligner + +```jsonnet +sloQuery.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn sloQuery.withProjectName + +```jsonnet +sloQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn sloQuery.withSelectorName + +```jsonnet +sloQuery.withSelectorName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +SLO selector. +#### fn sloQuery.withServiceId + +```jsonnet +sloQuery.withServiceId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the service the SLO is in. +#### fn sloQuery.withServiceName + +```jsonnet +sloQuery.withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name for the service the SLO is in. +#### fn sloQuery.withSloId + +```jsonnet +sloQuery.withSloId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +ID for the SLO. +#### fn sloQuery.withSloName + +```jsonnet +sloQuery.withSloName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the SLO. +### obj timeSeriesList + + +#### fn timeSeriesList.withAlignmentPeriod + +```jsonnet +timeSeriesList.withAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withCrossSeriesReducer + +```jsonnet +timeSeriesList.withCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withFilters + +```jsonnet +timeSeriesList.withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withFiltersMixin + +```jsonnet +timeSeriesList.withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of filters to query data by. Labels that can be filtered on are defined by the metric. +#### fn timeSeriesList.withGroupBys + +```jsonnet +timeSeriesList.withGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withGroupBysMixin + +```jsonnet +timeSeriesList.withGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Array of labels to group data by. +#### fn timeSeriesList.withPerSeriesAligner + +```jsonnet +timeSeriesList.withPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withPreprocessor + +```jsonnet +timeSeriesList.withPreprocessor(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"none"`, `"rate"`, `"delta"` + +Types of pre-processor available. Defined by the metric. +#### fn timeSeriesList.withProjectName + +```jsonnet +timeSeriesList.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesList.withSecondaryAlignmentPeriod + +```jsonnet +timeSeriesList.withSecondaryAlignmentPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto. +#### fn timeSeriesList.withSecondaryCrossSeriesReducer + +```jsonnet +timeSeriesList.withSecondaryCrossSeriesReducer(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE. +#### fn timeSeriesList.withSecondaryGroupBys + +```jsonnet +timeSeriesList.withSecondaryGroupBys(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryGroupBysMixin + +```jsonnet +timeSeriesList.withSecondaryGroupBysMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Only present if a preprocessor is selected. Array of labels to group data by. +#### fn timeSeriesList.withSecondaryPerSeriesAligner + +```jsonnet +timeSeriesList.withSecondaryPerSeriesAligner(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN. +#### fn timeSeriesList.withText + +```jsonnet +timeSeriesList.withText(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation text. +#### fn timeSeriesList.withTitle + +```jsonnet +timeSeriesList.withTitle(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Annotation title. +#### fn timeSeriesList.withView + +```jsonnet +timeSeriesList.withView(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Data view, defaults to FULL. +### obj timeSeriesQuery + + +#### fn timeSeriesQuery.withGraphPeriod + +```jsonnet +timeSeriesQuery.withGraphPeriod(value="disabled") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"disabled"` + +To disable the graphPeriod, it should explictly be set to 'disabled'. +#### fn timeSeriesQuery.withProjectName + +```jsonnet +timeSeriesQuery.withProjectName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +GCP project to execute the query against. +#### fn timeSeriesQuery.withQuery + +```jsonnet +timeSeriesQuery.withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +MQL query to be executed. \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/grafanaPyroscope.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/grafanaPyroscope.md new file mode 100644 index 0000000..a8dd684 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/grafanaPyroscope.md @@ -0,0 +1,174 @@ +# grafanaPyroscope + +grafonnet.query.grafanaPyroscope + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withMaxNodes(value)`](#fn-withmaxnodes) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSpanSelector(value)`](#fn-withspanselector) +* [`fn withSpanSelectorMixin(value)`](#fn-withspanselectormixin) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Allows to group the results. +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Allows to group the results. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. +### fn withMaxNodes + +```jsonnet +withMaxNodes(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Sets the maximum number of nodes in the flamegraph. +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the type of profile to query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSpanSelector + +```jsonnet +withSpanSelector(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Specifies the query span selectors. +### fn withSpanSelectorMixin + +```jsonnet +withSpanSelectorMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Specifies the query span selectors. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/index.md new file mode 100644 index 0000000..2ca9588 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/index.md @@ -0,0 +1,19 @@ +# query + +grafonnet.query + +## Subpackages + +* [athena](athena.md) +* [azureMonitor](azureMonitor/index.md) +* [bigquery](bigquery/index.md) +* [cloudWatch](cloudWatch/index.md) +* [elasticsearch](elasticsearch/index.md) +* [expr](expr/index.md) +* [googleCloudMonitoring](googleCloudMonitoring.md) +* [grafanaPyroscope](grafanaPyroscope.md) +* [loki](loki.md) +* [parca](parca.md) +* [prometheus](prometheus.md) +* [tempo](tempo/index.md) +* [testData](testData/index.md) diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/loki.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/loki.md new file mode 100644 index 0000000..56eb6c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/loki.md @@ -0,0 +1,201 @@ +# loki + +grafonnet.query.loki + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withMaxLines(value)`](#fn-withmaxlines) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResolution(value)`](#fn-withresolution) +* [`fn withStep(value)`](#fn-withstep) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new loki query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + + +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The LogQL query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated, now use queryType. +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used to override the name of the series. +### fn withMaxLines + +```jsonnet +withMaxLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Used to limit the number of log rows returned. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +@deprecated, now use queryType. +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withResolution + +```jsonnet +withResolution(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +@deprecated, now use step. +### fn withStep + +```jsonnet +withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used to set step value for range queries. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/parca.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/parca.md new file mode 100644 index 0000000..8790944 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/parca.md @@ -0,0 +1,114 @@ +# parca + +grafonnet.query.parca + +## Index + +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLabelSelector(value="{}")`](#fn-withlabelselector) +* [`fn withProfileTypeId(value)`](#fn-withprofiletypeid) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLabelSelector + +```jsonnet +withLabelSelector(value="{}") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"{}"` + +Specifies the query label selectors. +### fn withProfileTypeId + +```jsonnet +withProfileTypeId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specifies the type of profile to query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/prometheus.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/prometheus.md new file mode 100644 index 0000000..737c753 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/prometheus.md @@ -0,0 +1,216 @@ +# prometheus + +grafonnet.query.prometheus + +## Index + +* [`fn new(datasource, expr)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withEditorMode(value)`](#fn-witheditormode) +* [`fn withExemplar(value=true)`](#fn-withexemplar) +* [`fn withExpr(value)`](#fn-withexpr) +* [`fn withFormat(value)`](#fn-withformat) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withInstant(value=true)`](#fn-withinstant) +* [`fn withInterval(value)`](#fn-withinterval) +* [`fn withIntervalFactor(value)`](#fn-withintervalfactor) +* [`fn withLegendFormat(value)`](#fn-withlegendformat) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRange(value=true)`](#fn-withrange) +* [`fn withRefId(value)`](#fn-withrefid) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(datasource, expr) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **expr** (`string`) + +Creates a new prometheus query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withEditorMode + +```jsonnet +withEditorMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"code"`, `"builder"` + +Specifies which editor is being used to prepare the query. It can be "code" or "builder" +### fn withExemplar + +```jsonnet +withExemplar(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Execute an additional query to identify interesting raw samples relevant for the given expr +### fn withExpr + +```jsonnet +withExpr(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The actual expression/query that will be evaluated by Prometheus +### fn withFormat + +```jsonnet +withFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"time_series"`, `"table"`, `"heatmap"` + +Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap" +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withInstant + +```jsonnet +withInstant(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Returns only the latest value that Prometheus has scraped for the requested time series +### fn withInterval + +```jsonnet +withInterval(value) +``` + +PARAMETERS: + +* **value** (`string`) + +An additional lower limit for the step parameter of the Prometheus query and for the +`$__interval` and `$__rate_interval` variables. +### fn withIntervalFactor + +```jsonnet +withIntervalFactor(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the interval factor for this query. +### fn withLegendFormat + +```jsonnet +withLegendFormat(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the legend format for this query. +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRange + +```jsonnet +withRange(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/filters.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/filters.md new file mode 100644 index 0000000..4482fd2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/filters.md @@ -0,0 +1,94 @@ +# filters + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/groupBy.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/groupBy.md new file mode 100644 index 0000000..795b78e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/groupBy.md @@ -0,0 +1,94 @@ +# groupBy + + + +## Index + +* [`fn withId(value)`](#fn-withid) +* [`fn withOperator(value)`](#fn-withoperator) +* [`fn withScope(value)`](#fn-withscope) +* [`fn withTag(value)`](#fn-withtag) +* [`fn withValue(value)`](#fn-withvalue) +* [`fn withValueMixin(value)`](#fn-withvaluemixin) +* [`fn withValueType(value)`](#fn-withvaluetype) + +## Fields + +### fn withId + +```jsonnet +withId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Uniquely identify the filter, will not be used in the query generation +### fn withOperator + +```jsonnet +withOperator(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The operator that connects the tag to the value, for example: =, >, !=, =~ +### fn withScope + +```jsonnet +withScope(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"intrinsic"`, `"unscoped"`, `"resource"`, `"span"` + +static fields are pre-set in the UI, dynamic fields are added by the user +### fn withTag + +```jsonnet +withTag(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The tag for the search filter, for example: .http.status_code, .service.name, status +### fn withValue + +```jsonnet +withValue(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueMixin + +```jsonnet +withValueMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +The value for the search filter +### fn withValueType + +```jsonnet +withValueType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/index.md new file mode 100644 index 0000000..182301b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/tempo/index.md @@ -0,0 +1,314 @@ +# tempo + +grafonnet.query.tempo + +## Subpackages + +* [filters](filters.md) +* [groupBy](groupBy.md) + +## Index + +* [`fn new(datasource, query, filters)`](#fn-new) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withFilters(value)`](#fn-withfilters) +* [`fn withFiltersMixin(value)`](#fn-withfiltersmixin) +* [`fn withGroupBy(value)`](#fn-withgroupby) +* [`fn withGroupByMixin(value)`](#fn-withgroupbymixin) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withLimit(value)`](#fn-withlimit) +* [`fn withMaxDuration(value)`](#fn-withmaxduration) +* [`fn withMinDuration(value)`](#fn-withminduration) +* [`fn withQuery(value)`](#fn-withquery) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withSearch(value)`](#fn-withsearch) +* [`fn withServiceMapIncludeNamespace(value=true)`](#fn-withservicemapincludenamespace) +* [`fn withServiceMapQuery(value)`](#fn-withservicemapquery) +* [`fn withServiceMapQueryMixin(value)`](#fn-withservicemapquerymixin) +* [`fn withServiceName(value)`](#fn-withservicename) +* [`fn withSpanName(value)`](#fn-withspanname) +* [`fn withSpss(value)`](#fn-withspss) +* [`fn withStep(value)`](#fn-withstep) +* [`fn withTableType(value)`](#fn-withtabletype) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) + +## Fields + +### fn new + +```jsonnet +new(datasource, query, filters) +``` + +PARAMETERS: + +* **datasource** (`string`) +* **query** (`string`) +* **filters** (`array`) + +Creates a new tempo query target for panels. +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withFilters + +```jsonnet +withFilters(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withFiltersMixin + +```jsonnet +withFiltersMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withGroupBy + +```jsonnet +withGroupBy(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withGroupByMixin + +```jsonnet +withGroupByMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +Filters that are used to query the metrics summary +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel. +### fn withLimit + +```jsonnet +withLimit(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of traces that are returned from Tempo +### fn withMaxDuration + +```jsonnet +withMaxDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withMinDuration + +```jsonnet +withMinDuration(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms +### fn withQuery + +```jsonnet +withQuery(value) +``` + +PARAMETERS: + +* **value** (`string`) + +TraceQL query or trace ID +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specify the query flavor +TODO make this required and give it a default +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +A unique identifier for the query within the list of targets. +In server side expressions, the refId is used as a variable name to identify results. +By default, the UI will assign A->Z; however setting meaningful names may be useful. +### fn withSearch + +```jsonnet +withSearch(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true +### fn withServiceMapIncludeNamespace + +```jsonnet +withServiceMapIncludeNamespace(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Use service.namespace in addition to service.name to uniquely identify a service. +### fn withServiceMapQuery + +```jsonnet +withServiceMapQuery(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceMapQueryMixin + +```jsonnet +withServiceMapQueryMixin(value) +``` + +PARAMETERS: + +* **value** (`array`,`string`) + +Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally. +### fn withServiceName + +```jsonnet +withServiceName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by service name +### fn withSpanName + +```jsonnet +withSpanName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +@deprecated Query traces by span name +### fn withSpss + +```jsonnet +withSpss(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Defines the maximum number of spans per spanset that are returned from Tempo +### fn withStep + +```jsonnet +withStep(value) +``` + +PARAMETERS: + +* **value** (`string`) + +For metric queries, the step size to use +### fn withTableType + +```jsonnet +withTableType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"traces"`, `"spans"`, `"raw"` + +The type of the table that is used to display the search results +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/csvWave.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/csvWave.md new file mode 100644 index 0000000..8927e1c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/csvWave.md @@ -0,0 +1,56 @@ +# csvWave + + + +## Index + +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withName(value)`](#fn-withname) +* [`fn withTimeStep(value)`](#fn-withtimestep) +* [`fn withValuesCSV(value)`](#fn-withvaluescsv) + +## Fields + +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withTimeStep + +```jsonnet +withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withValuesCSV + +```jsonnet +withValuesCSV(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/index.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/index.md new file mode 100644 index 0000000..7f02d6f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/query/testData/index.md @@ -0,0 +1,1111 @@ +# testData + +grafonnet.query.testData + +## Subpackages + +* [csvWave](csvWave.md) + +## Index + +* [`fn withAlias(value)`](#fn-withalias) +* [`fn withChannel(value)`](#fn-withchannel) +* [`fn withCsvContent(value)`](#fn-withcsvcontent) +* [`fn withCsvFileName(value)`](#fn-withcsvfilename) +* [`fn withCsvWave(value)`](#fn-withcsvwave) +* [`fn withCsvWaveMixin(value)`](#fn-withcsvwavemixin) +* [`fn withDatasource(value)`](#fn-withdatasource) +* [`fn withDropPercent(value)`](#fn-withdroppercent) +* [`fn withErrorType(value)`](#fn-witherrortype) +* [`fn withFlamegraphDiff(value=true)`](#fn-withflamegraphdiff) +* [`fn withHide(value=true)`](#fn-withhide) +* [`fn withIntervalMs(value)`](#fn-withintervalms) +* [`fn withLabels(value)`](#fn-withlabels) +* [`fn withLevelColumn(value=true)`](#fn-withlevelcolumn) +* [`fn withLines(value)`](#fn-withlines) +* [`fn withMax(value)`](#fn-withmax) +* [`fn withMaxDataPoints(value)`](#fn-withmaxdatapoints) +* [`fn withMin(value)`](#fn-withmin) +* [`fn withNodes(value)`](#fn-withnodes) +* [`fn withNodesMixin(value)`](#fn-withnodesmixin) +* [`fn withNoise(value)`](#fn-withnoise) +* [`fn withPoints(value)`](#fn-withpoints) +* [`fn withPointsMixin(value)`](#fn-withpointsmixin) +* [`fn withPulseWave(value)`](#fn-withpulsewave) +* [`fn withPulseWaveMixin(value)`](#fn-withpulsewavemixin) +* [`fn withQueryType(value)`](#fn-withquerytype) +* [`fn withRawFrameContent(value)`](#fn-withrawframecontent) +* [`fn withRefId(value)`](#fn-withrefid) +* [`fn withResultAssertions(value)`](#fn-withresultassertions) +* [`fn withResultAssertionsMixin(value)`](#fn-withresultassertionsmixin) +* [`fn withScenarioId(value)`](#fn-withscenarioid) +* [`fn withSeriesCount(value)`](#fn-withseriescount) +* [`fn withSim(value)`](#fn-withsim) +* [`fn withSimMixin(value)`](#fn-withsimmixin) +* [`fn withSpanCount(value)`](#fn-withspancount) +* [`fn withSpread(value)`](#fn-withspread) +* [`fn withStartValue(value)`](#fn-withstartvalue) +* [`fn withStream(value)`](#fn-withstream) +* [`fn withStreamMixin(value)`](#fn-withstreammixin) +* [`fn withStringInput(value)`](#fn-withstringinput) +* [`fn withTimeRange(value)`](#fn-withtimerange) +* [`fn withTimeRangeMixin(value)`](#fn-withtimerangemixin) +* [`fn withUsa(value)`](#fn-withusa) +* [`fn withUsaMixin(value)`](#fn-withusamixin) +* [`fn withWithNil(value=true)`](#fn-withwithnil) +* [`obj datasource`](#obj-datasource) + * [`fn withType(value)`](#fn-datasourcewithtype) + * [`fn withUid(value)`](#fn-datasourcewithuid) +* [`obj nodes`](#obj-nodes) + * [`fn withCount(value)`](#fn-nodeswithcount) + * [`fn withSeed(value)`](#fn-nodeswithseed) + * [`fn withType(value)`](#fn-nodeswithtype) +* [`obj pulseWave`](#obj-pulsewave) + * [`fn withOffCount(value)`](#fn-pulsewavewithoffcount) + * [`fn withOffValue(value)`](#fn-pulsewavewithoffvalue) + * [`fn withOnCount(value)`](#fn-pulsewavewithoncount) + * [`fn withOnValue(value)`](#fn-pulsewavewithonvalue) + * [`fn withTimeStep(value)`](#fn-pulsewavewithtimestep) +* [`obj resultAssertions`](#obj-resultassertions) + * [`fn withMaxFrames(value)`](#fn-resultassertionswithmaxframes) + * [`fn withType(value)`](#fn-resultassertionswithtype) + * [`fn withTypeVersion(value)`](#fn-resultassertionswithtypeversion) + * [`fn withTypeVersionMixin(value)`](#fn-resultassertionswithtypeversionmixin) +* [`obj sim`](#obj-sim) + * [`fn withConfig(value)`](#fn-simwithconfig) + * [`fn withConfigMixin(value)`](#fn-simwithconfigmixin) + * [`fn withKey(value)`](#fn-simwithkey) + * [`fn withKeyMixin(value)`](#fn-simwithkeymixin) + * [`fn withLast(value=true)`](#fn-simwithlast) + * [`fn withStream(value=true)`](#fn-simwithstream) + * [`obj key`](#obj-simkey) + * [`fn withTick(value)`](#fn-simkeywithtick) + * [`fn withType(value)`](#fn-simkeywithtype) + * [`fn withUid(value)`](#fn-simkeywithuid) +* [`obj stream`](#obj-stream) + * [`fn withBands(value)`](#fn-streamwithbands) + * [`fn withNoise(value)`](#fn-streamwithnoise) + * [`fn withSpeed(value)`](#fn-streamwithspeed) + * [`fn withSpread(value)`](#fn-streamwithspread) + * [`fn withType(value)`](#fn-streamwithtype) + * [`fn withUrl(value)`](#fn-streamwithurl) +* [`obj timeRange`](#obj-timerange) + * [`fn withFrom(value="now-6h")`](#fn-timerangewithfrom) + * [`fn withTo(value="now")`](#fn-timerangewithto) +* [`obj usa`](#obj-usa) + * [`fn withFields(value)`](#fn-usawithfields) + * [`fn withFieldsMixin(value)`](#fn-usawithfieldsmixin) + * [`fn withMode(value)`](#fn-usawithmode) + * [`fn withPeriod(value)`](#fn-usawithperiod) + * [`fn withStates(value)`](#fn-usawithstates) + * [`fn withStatesMixin(value)`](#fn-usawithstatesmixin) + +## Fields + +### fn withAlias + +```jsonnet +withAlias(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withChannel + +```jsonnet +withChannel(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Used for live query +### fn withCsvContent + +```jsonnet +withCsvContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvFileName + +```jsonnet +withCsvFileName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withCsvWave + +```jsonnet +withCsvWave(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withCsvWaveMixin + +```jsonnet +withCsvWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withDatasource + +```jsonnet +withDatasource(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Set the datasource for this query. +### fn withDropPercent + +```jsonnet +withDropPercent(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Drop percentage (the chance we will lose a point 0-100) +### fn withErrorType + +```jsonnet +withErrorType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"frontend_exception"`, `"frontend_observable"`, `"server_panic"` + +Possible enum values: + - `"frontend_exception"` + - `"frontend_observable"` + - `"server_panic"` +### fn withFlamegraphDiff + +```jsonnet +withFlamegraphDiff(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withHide + +```jsonnet +withHide(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +true if query is disabled (ie should not be returned to the dashboard) +NOTE: this does not always imply that the query should not be executed since +the results from a hidden query may be used as the input to other queries (SSE etc) +### fn withIntervalMs + +```jsonnet +withIntervalMs(value) +``` + +PARAMETERS: + +* **value** (`number`) + +Interval is the suggested duration between time points in a time series query. +NOTE: the values for intervalMs is not saved in the query model. It is typically calculated +from the interval required to fill a pixels in the visualization +### fn withLabels + +```jsonnet +withLabels(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withLevelColumn + +```jsonnet +withLevelColumn(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### fn withLines + +```jsonnet +withLines(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withMax + +```jsonnet +withMax(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withMaxDataPoints + +```jsonnet +withMaxDataPoints(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +MaxDataPoints is the maximum number of data points that should be returned from a time series query. +NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated +from the number of pixels visible in a visualization +### fn withMin + +```jsonnet +withMin(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withNodes + +```jsonnet +withNodes(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNodesMixin + +```jsonnet +withNodesMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withNoise + +```jsonnet +withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withPoints + +```jsonnet +withPoints(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPointsMixin + +```jsonnet +withPointsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +### fn withPulseWave + +```jsonnet +withPulseWave(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withPulseWaveMixin + +```jsonnet +withPulseWaveMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withQueryType + +```jsonnet +withQueryType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +QueryType is an optional identifier for the type of query. +It can be used to distinguish different types of queries. +### fn withRawFrameContent + +```jsonnet +withRawFrameContent(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withRefId + +```jsonnet +withRefId(value) +``` + +PARAMETERS: + +* **value** (`string`) + +RefID is the unique identifier of the query, set by the frontend call. +### fn withResultAssertions + +```jsonnet +withResultAssertions(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withResultAssertionsMixin + +```jsonnet +withResultAssertionsMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +Optionally define expected query result behavior +### fn withScenarioId + +```jsonnet +withScenarioId(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"annotations"`, `"arrow"`, `"csv_content"`, `"csv_file"`, `"csv_metric_values"`, `"datapoints_outside_range"`, `"exponential_heatmap_bucket_data"`, `"flame_graph"`, `"grafana_api"`, `"linear_heatmap_bucket_data"`, `"live"`, `"logs"`, `"manual_entry"`, `"no_data_points"`, `"node_graph"`, `"predictable_csv_wave"`, `"predictable_pulse"`, `"random_walk"`, `"random_walk_table"`, `"random_walk_with_error"`, `"raw_frame"`, `"server_error_500"`, `"simulation"`, `"slow_query"`, `"streaming_client"`, `"table_static"`, `"trace"`, `"usa"`, `"variables-query"` + +Possible enum values: + - `"annotations"` + - `"arrow"` + - `"csv_content"` + - `"csv_file"` + - `"csv_metric_values"` + - `"datapoints_outside_range"` + - `"exponential_heatmap_bucket_data"` + - `"flame_graph"` + - `"grafana_api"` + - `"linear_heatmap_bucket_data"` + - `"live"` + - `"logs"` + - `"manual_entry"` + - `"no_data_points"` + - `"node_graph"` + - `"predictable_csv_wave"` + - `"predictable_pulse"` + - `"random_walk"` + - `"random_walk_table"` + - `"random_walk_with_error"` + - `"raw_frame"` + - `"server_error_500"` + - `"simulation"` + - `"slow_query"` + - `"streaming_client"` + - `"table_static"` + - `"trace"` + - `"usa"` + - `"variables-query"` +### fn withSeriesCount + +```jsonnet +withSeriesCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSim + +```jsonnet +withSim(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSimMixin + +```jsonnet +withSimMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withSpanCount + +```jsonnet +withSpanCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### fn withSpread + +```jsonnet +withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStartValue + +```jsonnet +withStartValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +### fn withStream + +```jsonnet +withStream(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStreamMixin + +```jsonnet +withStreamMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withStringInput + +```jsonnet +withStringInput(value) +``` + +PARAMETERS: + +* **value** (`string`) + +common parameter used by many query types +### fn withTimeRange + +```jsonnet +withTimeRange(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withTimeRangeMixin + +```jsonnet +withTimeRangeMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +TimeRange represents the query range +NOTE: unlike generic /ds/query, we can now send explicit time values in each query +NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly +### fn withUsa + +```jsonnet +withUsa(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withUsaMixin + +```jsonnet +withUsaMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +### fn withWithNil + +```jsonnet +withWithNil(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +### obj datasource + + +#### fn datasource.withType + +```jsonnet +datasource.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The plugin type-id +#### fn datasource.withUid + +```jsonnet +datasource.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Specific datasource instance +### obj nodes + + +#### fn nodes.withCount + +```jsonnet +nodes.withCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withSeed + +```jsonnet +nodes.withSeed(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn nodes.withType + +```jsonnet +nodes.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"random"`, `"random edges"`, `"response_medium"`, `"response_small"`, `"feature_showcase"` + +Possible enum values: + - `"random"` + - `"random edges"` + - `"response_medium"` + - `"response_small"` + - `"feature_showcase"` +### obj pulseWave + + +#### fn pulseWave.withOffCount + +```jsonnet +pulseWave.withOffCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOffValue + +```jsonnet +pulseWave.withOffValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withOnCount + +```jsonnet +pulseWave.withOnCount(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn pulseWave.withOnValue + +```jsonnet +pulseWave.withOnValue(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn pulseWave.withTimeStep + +```jsonnet +pulseWave.withTimeStep(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +### obj resultAssertions + + +#### fn resultAssertions.withMaxFrames + +```jsonnet +resultAssertions.withMaxFrames(value) +``` + +PARAMETERS: + +* **value** (`integer`) + +Maximum frame count +#### fn resultAssertions.withType + +```jsonnet +resultAssertions.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `""`, `"timeseries-wide"`, `"timeseries-long"`, `"timeseries-many"`, `"timeseries-multi"`, `"directory-listing"`, `"table"`, `"numeric-wide"`, `"numeric-multi"`, `"numeric-long"`, `"log-lines"` + +Type asserts that the frame matches a known type structure. +Possible enum values: + - `""` + - `"timeseries-wide"` + - `"timeseries-long"` + - `"timeseries-many"` + - `"timeseries-multi"` + - `"directory-listing"` + - `"table"` + - `"numeric-wide"` + - `"numeric-multi"` + - `"numeric-long"` + - `"log-lines"` +#### fn resultAssertions.withTypeVersion + +```jsonnet +resultAssertions.withTypeVersion(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +#### fn resultAssertions.withTypeVersionMixin + +```jsonnet +resultAssertions.withTypeVersionMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + +TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane +contract documentation https://grafana.github.io/dataplane/contract/. +### obj sim + + +#### fn sim.withConfig + +```jsonnet +sim.withConfig(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withConfigMixin + +```jsonnet +sim.withConfigMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKey + +```jsonnet +sim.withKey(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withKeyMixin + +```jsonnet +sim.withKeyMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn sim.withLast + +```jsonnet +sim.withLast(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### fn sim.withStream + +```jsonnet +sim.withStream(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + + +#### obj sim.key + + +##### fn sim.key.withTick + +```jsonnet +sim.key.withTick(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +##### fn sim.key.withType + +```jsonnet +sim.key.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +##### fn sim.key.withUid + +```jsonnet +sim.key.withUid(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj stream + + +#### fn stream.withBands + +```jsonnet +stream.withBands(value) +``` + +PARAMETERS: + +* **value** (`integer`) + + +#### fn stream.withNoise + +```jsonnet +stream.withNoise(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpeed + +```jsonnet +stream.withSpeed(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withSpread + +```jsonnet +stream.withSpread(value) +``` + +PARAMETERS: + +* **value** (`number`) + + +#### fn stream.withType + +```jsonnet +stream.withType(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"fetch"`, `"logs"`, `"signal"`, `"traces"` + +Possible enum values: + - `"fetch"` + - `"logs"` + - `"signal"` + - `"traces"` +#### fn stream.withUrl + +```jsonnet +stream.withUrl(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj timeRange + + +#### fn timeRange.withFrom + +```jsonnet +timeRange.withFrom(value="now-6h") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now-6h"` + +From is the start time of the query. +#### fn timeRange.withTo + +```jsonnet +timeRange.withTo(value="now") +``` + +PARAMETERS: + +* **value** (`string`) + - default value: `"now"` + +To is the end time of the query. +### obj usa + + +#### fn usa.withFields + +```jsonnet +usa.withFields(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withFieldsMixin + +```jsonnet +usa.withFieldsMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withMode + +```jsonnet +usa.withMode(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withPeriod + +```jsonnet +usa.withPeriod(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +#### fn usa.withStates + +```jsonnet +usa.withStates(value) +``` + +PARAMETERS: + +* **value** (`array`) + + +#### fn usa.withStatesMixin + +```jsonnet +usa.withStatesMixin(value) +``` + +PARAMETERS: + +* **value** (`array`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/role.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/role.md new file mode 100644 index 0000000..b5b551c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/role.md @@ -0,0 +1,70 @@ +# role + +grafonnet.role + +## Index + +* [`fn withDescription(value)`](#fn-withdescription) +* [`fn withDisplayName(value)`](#fn-withdisplayname) +* [`fn withGroupName(value)`](#fn-withgroupname) +* [`fn withHidden(value=true)`](#fn-withhidden) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withDescription + +```jsonnet +withDescription(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Role description +### fn withDisplayName + +```jsonnet +withDisplayName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Optional display +### fn withGroupName + +```jsonnet +withGroupName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +Name of the team. +### fn withHidden + +```jsonnet +withHidden(value=true) +``` + +PARAMETERS: + +* **value** (`boolean`) + - default value: `true` + +Do not show this role +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The role identifier `managed:builtins:editor:permissions` \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/rolebinding.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/rolebinding.md new file mode 100644 index 0000000..fb8c746 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/rolebinding.md @@ -0,0 +1,189 @@ +# rolebinding + +grafonnet.rolebinding + +## Index + +* [`fn withRole(value)`](#fn-withrole) +* [`fn withRoleMixin(value)`](#fn-withrolemixin) +* [`fn withSubject(value)`](#fn-withsubject) +* [`fn withSubjectMixin(value)`](#fn-withsubjectmixin) +* [`obj role`](#obj-role) + * [`fn withBuiltinRoleRef(value)`](#fn-rolewithbuiltinroleref) + * [`fn withBuiltinRoleRefMixin(value)`](#fn-rolewithbuiltinrolerefmixin) + * [`fn withCustomRoleRef(value)`](#fn-rolewithcustomroleref) + * [`fn withCustomRoleRefMixin(value)`](#fn-rolewithcustomrolerefmixin) + * [`obj BuiltinRoleRef`](#obj-rolebuiltinroleref) + * [`fn withKind()`](#fn-rolebuiltinrolerefwithkind) + * [`fn withName(value)`](#fn-rolebuiltinrolerefwithname) + * [`obj CustomRoleRef`](#obj-rolecustomroleref) + * [`fn withKind()`](#fn-rolecustomrolerefwithkind) + * [`fn withName(value)`](#fn-rolecustomrolerefwithname) +* [`obj subject`](#obj-subject) + * [`fn withKind(value)`](#fn-subjectwithkind) + * [`fn withName(value)`](#fn-subjectwithname) + +## Fields + +### fn withRole + +```jsonnet +withRole(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withRoleMixin + +```jsonnet +withRoleMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The role we are discussing +### fn withSubject + +```jsonnet +withSubject(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The team or user that has the specified role +### fn withSubjectMixin + +```jsonnet +withSubjectMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + +The team or user that has the specified role +### obj role + + +#### fn role.withBuiltinRoleRef + +```jsonnet +role.withBuiltinRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withBuiltinRoleRefMixin + +```jsonnet +role.withBuiltinRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRef + +```jsonnet +role.withCustomRoleRef(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### fn role.withCustomRoleRefMixin + +```jsonnet +role.withCustomRoleRefMixin(value) +``` + +PARAMETERS: + +* **value** (`object`) + + +#### obj role.BuiltinRoleRef + + +##### fn role.BuiltinRoleRef.withKind + +```jsonnet +role.BuiltinRoleRef.withKind() +``` + + + +##### fn role.BuiltinRoleRef.withName + +```jsonnet +role.BuiltinRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"viewer"`, `"editor"`, `"admin"` + + +#### obj role.CustomRoleRef + + +##### fn role.CustomRoleRef.withKind + +```jsonnet +role.CustomRoleRef.withKind() +``` + + + +##### fn role.CustomRoleRef.withName + +```jsonnet +role.CustomRoleRef.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### obj subject + + +#### fn subject.withKind + +```jsonnet +subject.withKind(value) +``` + +PARAMETERS: + +* **value** (`string`) + - valid values: `"Team"`, `"User"` + + +#### fn subject.withName + +```jsonnet +subject.withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + +The team/user identifier name \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/team.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/team.md new file mode 100644 index 0000000..c62e20a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/team.md @@ -0,0 +1,32 @@ +# team + +grafonnet.team + +## Index + +* [`fn withEmail(value)`](#fn-withemail) +* [`fn withName(value)`](#fn-withname) + +## Fields + +### fn withEmail + +```jsonnet +withEmail(value) +``` + +PARAMETERS: + +* **value** (`string`) + + +### fn withName + +```jsonnet +withName(value) +``` + +PARAMETERS: + +* **value** (`string`) + diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/util.md b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/util.md new file mode 100644 index 0000000..af88a40 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/docs/util.md @@ -0,0 +1,328 @@ +# util + +Helper functions that work well with Grafonnet. + +## Index + +* [`obj dashboard`](#obj-dashboard) + * [`fn getOptionsForCustomQuery(query)`](#fn-dashboardgetoptionsforcustomquery) +* [`obj grid`](#obj-grid) + * [`fn makeGrid(panels, panelWidth, panelHeight, startY)`](#fn-gridmakegrid) + * [`fn wrapPanels(panels, panelWidth, panelHeight, startY)`](#fn-gridwrappanels) +* [`obj panel`](#obj-panel) + * [`fn calculateLowestYforPanel(panel, panels)`](#fn-panelcalculatelowestyforpanel) + * [`fn dedupeQueryTargets(panels)`](#fn-paneldedupequerytargets) + * [`fn getPanelIDs(panels)`](#fn-panelgetpanelids) + * [`fn getPanelsBeforeNextRow(panels)`](#fn-panelgetpanelsbeforenextrow) + * [`fn groupPanelsInRows(panels)`](#fn-panelgrouppanelsinrows) + * [`fn mapToRows(func, panels)`](#fn-panelmaptorows) + * [`fn normalizeY(panels)`](#fn-panelnormalizey) + * [`fn normalizeYInRow(rowPanel)`](#fn-panelnormalizeyinrow) + * [`fn resolveCollapsedFlagOnRows(panels)`](#fn-panelresolvecollapsedflagonrows) + * [`fn sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8)`](#fn-panelsanitizepanel) + * [`fn setPanelIDs(panels, overrideExistingIDs=true)`](#fn-panelsetpanelids) + * [`fn setRefIDs(panel, overrideExistingIDs=true)`](#fn-panelsetrefids) + * [`fn setRefIDsOnPanels(panels)`](#fn-panelsetrefidsonpanels) + * [`fn sortPanelsByXY(panels)`](#fn-panelsortpanelsbyxy) + * [`fn sortPanelsInRow(rowPanel)`](#fn-panelsortpanelsinrow) + * [`fn validatePanelIDs(panels)`](#fn-panelvalidatepanelids) +* [`obj string`](#obj-string) + * [`fn slugify(string)`](#fn-stringslugify) + +## Fields + +### obj dashboard + + +#### fn dashboard.getOptionsForCustomQuery + +```jsonnet +dashboard.getOptionsForCustomQuery(query) +``` + +PARAMETERS: + +* **query** (`string`) + +`getOptionsForCustomQuery` provides values for the `options` and `current` fields. +These are required for template variables of type 'custom'but do not automatically +get populated by Grafana when importing a dashboard from JSON. + +This is a bit of a hack and should always be called on functions that set `type` on +a template variable. Ideally Grafana populates these fields from the `query` value +but this provides a backwards compatible solution. + +### obj grid + + +#### fn grid.makeGrid + +```jsonnet +grid.makeGrid(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`makeGrid` returns an array of `panels` organized in a grid with equal `panelWidth` +and `panelHeight`. Row panels are used as "linebreaks", if a Row panel is collapsed, +then all panels below it will be folded into the row. + +This function will use the full grid of 24 columns, setting `panelWidth` to a value +that can divide 24 into equal parts will fill up the page nicely. (1, 2, 3, 4, 6, 8, 12) +Other value for `panelWidth` will leave a gap on the far right. + +Optional `startY` can be provided to place generated grid above or below existing panels. + +#### fn grid.wrapPanels + +```jsonnet +grid.wrapPanels(panels, panelWidth, panelHeight, startY) +``` + +PARAMETERS: + +* **panels** (`array`) +* **panelWidth** (`number`) +* **panelHeight** (`number`) +* **startY** (`number`) + +`wrapPanels` returns an array of `panels` organized in a grid, wrapping up to next 'row' if total width exceeds full grid of 24 columns. +'panelHeight' and 'panelWidth' are used unless panels already have height and width defined. + +### obj panel + + +#### fn panel.calculateLowestYforPanel + +```jsonnet +panel.calculateLowestYforPanel(panel, panels) +``` + +PARAMETERS: + +* **panel** (`object`) +* **panels** (`array`) + +`calculateLowestYforPanel` calculates Y for a given `panel` from the `gridPos` of an array of `panels`. This function is used in `normalizeY`. + +#### fn panel.dedupeQueryTargets + +```jsonnet +panel.dedupeQueryTargets(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`dedupeQueryTargets` dedupes the query targets in a set of panels and replaces the duplicates with a ['shared query'](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/share-query/). Sharing query results across panels reduces the number of queries made to your data source, which can improve the performance of your dashboard. + +This function requires that the query targets have `refId` set, `setRefIDs` and `setRefIDsOnPanels` can help with that. + +#### fn panel.getPanelIDs + +```jsonnet +panel.getPanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelIDs` returns an array with all panel IDs including IDs from panels in rows. + +#### fn panel.getPanelsBeforeNextRow + +```jsonnet +panel.getPanelsBeforeNextRow(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`getPanelsBeforeNextRow` returns all panels in an array up until a row has been found. Used in `groupPanelsInRows`. + +#### fn panel.groupPanelsInRows + +```jsonnet +panel.groupPanelsInRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`groupPanelsInRows` ensures that panels that come after a row panel in an array are added to the `row.panels` attribute. This can be useful to apply intermediate functions to only the panels that belong to a row. Finally the panel array should get processed by `resolveCollapsedFlagOnRows` to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.mapToRows + +```jsonnet +panel.mapToRows(func, panels) +``` + +PARAMETERS: + +* **func** (`function`) +* **panels** (`array`) + +`mapToRows` is a little helper function that applies `func` to all row panels in an array. Other panels in that array are returned ad verbatim. + +#### fn panel.normalizeY + +```jsonnet +panel.normalizeY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`normalizeY` applies negative gravity on the inverted Y axis. This mimics the behavior of Grafana: when a panel is created without panel above it, then it'll float upward. + +This is strictly not required as Grafana will do this on dashboard load, however it might be helpful when used when calculating the correct `gridPos`. + +#### fn panel.normalizeYInRow + +```jsonnet +panel.normalizeYInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`normalizeYInRow` applies `normalizeY` to the panels in a row panel. + +#### fn panel.resolveCollapsedFlagOnRows + +```jsonnet +panel.resolveCollapsedFlagOnRows(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`resolveCollapsedFlagOnRows` should be applied to the final panel array to "unfold" the rows that are not collapsed into the main array. + +#### fn panel.sanitizePanel + +```jsonnet +panel.sanitizePanel(panel, defaultX=0, defaultY=0, defaultHeight=8, defaultWidth=8) +``` + +PARAMETERS: + +* **panel** (`object`) +* **defaultX** (`number`) + - default value: `0` +* **defaultY** (`number`) + - default value: `0` +* **defaultHeight** (`number`) + - default value: `8` +* **defaultWidth** (`number`) + - default value: `8` + +`sanitizePanel` ensures the panel has a valid `gridPos` and row panels have `collapsed` and `panels`. This function is recursively applied to panels inside row panels. + +The default values for x,y,h,w are only applied if not already set. + +#### fn panel.setPanelIDs + +```jsonnet +panel.setPanelIDs(panels, overrideExistingIDs=true) +``` + +PARAMETERS: + +* **panels** (`array`) +* **overrideExistingIDs** (`bool`) + - default value: `true` + +`setPanelIDs` ensures that all `panels` have a unique ID, this function is used in `dashboard.withPanels` and `dashboard.withPanelsMixin` to provide a consistent experience. + +`overrideExistingIDs` can be set to not replace existing IDs, consider validating the IDs with `validatePanelIDs()` to ensure there are no duplicate IDs. + +#### fn panel.setRefIDs + +```jsonnet +panel.setRefIDs(panel, overrideExistingIDs=true) +``` + +PARAMETERS: + +* **panel** (`object`) +* **overrideExistingIDs** (`bool`) + - default value: `true` + +`setRefIDs` calculates the `refId` field for each target on a panel. + +#### fn panel.setRefIDsOnPanels + +```jsonnet +panel.setRefIDsOnPanels(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`setRefIDsOnPanels` applies `setRefIDs on all `panels`. + +#### fn panel.sortPanelsByXY + +```jsonnet +panel.sortPanelsByXY(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`sortPanelsByXY` applies a simple sorting algorithm, first by x then again by y. This does not take width and height into account. + +#### fn panel.sortPanelsInRow + +```jsonnet +panel.sortPanelsInRow(rowPanel) +``` + +PARAMETERS: + +* **rowPanel** (`object`) + +`sortPanelsInRow` applies `sortPanelsByXY` on the panels in a rowPanel. + +#### fn panel.validatePanelIDs + +```jsonnet +panel.validatePanelIDs(panels) +``` + +PARAMETERS: + +* **panels** (`array`) + +`validatePanelIDs` validates returns `false` if there are duplicate panel IDs in `panels`. + +### obj string + + +#### fn string.slugify + +```jsonnet +string.slugify(string) +``` + +PARAMETERS: + +* **string** (`string`) + +`slugify` will create a simple slug from `string`, keeping only alphanumeric +characters and replacing spaces with dashes. diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/folder.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/folder.libsonnet new file mode 100644 index 0000000..e462d48 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/folder.libsonnet @@ -0,0 +1,16 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.folder', name: 'folder' }, + '#withParentUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'only used if nested folders are enabled' } }, + withParentUid(value): { + parentUid: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder title' } }, + withTitle(value): { + title: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique folder id' } }, + withUid(value): { + uid: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/jsonnetfile.json b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/jsonnetfile.json new file mode 100644 index 0000000..8479d5a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/jsonnetfile.json @@ -0,0 +1,24 @@ +{ + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/docsonnet.git", + "subdir": "doc-util" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "master" + } + ], + "legacyImports": true, + "version": 1 +} \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/librarypanel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/librarypanel.libsonnet new file mode 100644 index 0000000..9c5194e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/librarypanel.libsonnet @@ -0,0 +1,1184 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.librarypanel', name: 'librarypanel' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description' } }, + withDescription(value): { + description: value, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Folder UID' } }, + withFolderUid(value): { + folderUid: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Object storage metadata' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Object storage metadata' } }, + withMetaMixin(value): { + meta+: value, + }, + meta+: + { + '#withConnectedDashboards': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withConnectedDashboards(value): { + meta+: { + connectedDashboards: value, + }, + }, + '#withCreated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCreated(value): { + meta+: { + created: value, + }, + }, + '#withCreatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedBy(value): { + meta+: { + createdBy: value, + }, + }, + '#withCreatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCreatedByMixin(value): { + meta+: { + createdBy+: value, + }, + }, + createdBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + createdBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + createdBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + createdBy+: { + name: value, + }, + }, + }, + }, + '#withFolderName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderName(value): { + meta+: { + folderName: value, + }, + }, + '#withFolderUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUid(value): { + meta+: { + folderUid: value, + }, + }, + '#withUpdated': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUpdated(value): { + meta+: { + updated: value, + }, + }, + '#withUpdatedBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedBy(value): { + meta+: { + updatedBy: value, + }, + }, + '#withUpdatedByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUpdatedByMixin(value): { + meta+: { + updatedBy+: value, + }, + }, + updatedBy+: + { + '#withAvatarUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAvatarUrl(value): { + meta+: { + updatedBy+: { + avatarUrl: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withId(value): { + meta+: { + updatedBy+: { + id: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + meta+: { + updatedBy+: { + name: value, + }, + }, + }, + }, + }, + '#withModel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Dashboard panels are the basic visualization building blocks.' } }, + withModel(value): { + model: value, + }, + '#withModelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Dashboard panels are the basic visualization building blocks.' } }, + withModelMixin(value): { + model+: value, + }, + model+: + { + '#withCacheTimeout': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets panel queries cache timeout.' } }, + withCacheTimeout(value): { + model+: { + cacheTimeout: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + model+: { + datasource: value, + }, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + model+: { + datasource+: value, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + model+: { + datasource+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + model+: { + datasource+: { + uid: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + model+: { + description: value, + }, + }, + '#withFieldConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfig(value): { + model+: { + fieldConfig: value, + }, + }, + '#withFieldConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withFieldConfigMixin(value): { + model+: { + fieldConfig+: value, + }, + }, + fieldConfig+: + { + '#withDefaults': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaults(value): { + model+: { + fieldConfig+: { + defaults: value, + }, + }, + }, + '#withDefaultsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results.\nEach column within this structure is called a field. A field can represent a single time series or table column.\nField options allow you to change how the data is displayed in your visualizations.' } }, + withDefaultsMixin(value): { + model+: { + fieldConfig+: { + defaults+: value, + }, + }, + }, + defaults+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color: value, + }, + }, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map a field to a color.' } }, + withColorMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: value, + }, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + model+: { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + }, + '#withCustom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustom(value): { + model+: { + fieldConfig+: { + defaults+: { + custom: value, + }, + }, + }, + }, + '#withCustomMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'custom is specified by the FieldConfig field\nin panel plugin schemas.' } }, + withCustomMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + custom+: value, + }, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + model+: { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Human readable field metadata' } }, + withDescription(value): { + model+: { + fieldConfig+: { + defaults+: { + description: value, + }, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + model+: { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + }, + '#withDisplayNameFromDS': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'This can be used by data sources that return and explicit naming structure for values and labels\nWhen this property is configured, this value is used rather than the default naming strategy.' } }, + withDisplayNameFromDS(value): { + model+: { + fieldConfig+: { + defaults+: { + displayNameFromDS: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + model+: { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + mappings+: + { + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + model+: { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + model+: { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + model+: { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + model+: { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + }, + '#withThresholds': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholds(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds: value, + }, + }, + }, + }, + '#withThresholdsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Thresholds configuration for the panel' } }, + withThresholdsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: value, + }, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + model+: { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + steps+: + { + '#': { help: '', name: 'steps' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + model+: { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + }, + '#withWriteable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source can write a value to the path. Auth/authz are supported separately' } }, + withWriteable(value=true): { + model+: { + fieldConfig+: { + defaults+: { + writeable: value, + }, + }, + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + model+: { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + model+: { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + overrides+: + { + '#': { help: '', name: 'overrides' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { + model+: { + hideTimeOverride: value, + }, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + model+: { + interval: value, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + model+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + model+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + links+: + { + '#': { help: '', name: 'links' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + model+: { + maxDataPoints: value, + }, + }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { + model+: { + maxPerRow: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptions(value): { + model+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.' } }, + withOptionsMixin(value): { + model+: { + options+: value, + }, + }, + '#withPluginVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.' } }, + withPluginVersion(value): { + model+: { + pluginVersion: value, + }, + }, + '#withQueryCachingTTL': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Overrides the data source configured time-to-live for a query cache item in milliseconds' } }, + withQueryCachingTTL(value): { + model+: { + queryCachingTTL: value, + }, + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + model+: { + repeat: value, + }, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + model+: { + repeatDirection: value, + }, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + model+: { + targets: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + model+: { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + model+: { + timeFrom: value, + }, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + model+: { + timeShift: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + model+: { + title: value, + }, + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + model+: { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + model+: { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + }, + transformations+: + { + '#': { help: '', name: 'transformations' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + model+: { + transparent: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + model+: { + type: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel name (also saved in the model)' } }, + withName(value): { + name: value, + }, + '#withSchemaVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Dashboard version when this was saved (zero if unknown)' } }, + withSchemaVersion(value): { + schemaVersion: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel type (from inside the model)' } }, + withType(value): { + type: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library element UID' } }, + withUid(value): { + uid: value, + }, + '#withVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'panel version, incremented each time the dashboard is updated.' } }, + withVersion(value): { + version: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet new file mode 100644 index 0000000..e80d456 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet @@ -0,0 +1,26 @@ +// This file is generated, do not manually edit. +{ + '#': { + filename: 'main.libsonnet', + help: 'Jsonnet library for rendering Grafana resources\n## Install\n\n```\njb install github.com/grafana/grafonnet/gen/grafonnet-v11.4.0@main\n```\n\n## Usage\n\n```jsonnet\nlocal grafonnet = import "github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet"\n```\n', + 'import': 'github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/main.libsonnet', + installTemplate: '\n## Install\n\n```\njb install %(url)s@%(version)s\n```\n', + name: 'grafonnet', + url: 'github.com/grafana/grafonnet/gen/grafonnet-v11.4.0', + usageTemplate: '\n## Usage\n\n```jsonnet\nlocal %(name)s = import "%(import)s"\n```\n', + version: 'main', + }, + accesspolicy: import 'accesspolicy.libsonnet', + dashboard: import 'dashboard.libsonnet', + librarypanel: import 'librarypanel.libsonnet', + preferences: import 'preferences.libsonnet', + publicdashboard: import 'publicdashboard.libsonnet', + role: import 'role.libsonnet', + rolebinding: import 'rolebinding.libsonnet', + team: import 'team.libsonnet', + folder: import 'folder.libsonnet', + panel: import 'panelindex.libsonnet', + query: import 'query.libsonnet', + util: import 'custom/util/main.libsonnet', + alerting: import 'alerting.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel.libsonnet new file mode 100644 index 0000000..b613912 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel.libsonnet @@ -0,0 +1,803 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + panelOptions+: + { + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel title.' } }, + withTitle(value): { + title: value, + }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Panel description.' } }, + withDescription(value): { + description: value, + }, + '#withTransparent': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether to display the panel without a background.' } }, + withTransparent(value=true): { + transparent: value, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinks(value): { + links: + (if std.isArray(value) + then value + else [value]), + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Panel links.' } }, + withLinksMixin(value): { + links+: + (if std.isArray(value) + then value + else [value]), + }, + '#withMaxPerRow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Option for repeated panels that controls max items per row\nOnly relevant for horizontally repeated panels' } }, + withMaxPerRow(value): { + maxPerRow: value, + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withRepeatDirection': { 'function': { args: [{ default: 'h', enums: ['h', 'v'], name: 'value', type: ['string'] }], help: "Direction to repeat in if 'repeat' is set.\n`h` for horizontal, `v` for vertical." } }, + withRepeatDirection(value='h'): { + repeatDirection: value, + }, + '#withPluginVersion': { 'function': { args: [], help: '' } }, + withPluginVersion(): { + pluginVersion: 'v11.4.0', + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The panel plugin type id. This is used to find the plugin to display the panel.' } }, + withType(value): { + type: value, + }, + link+: + { + '#': { help: '', name: 'link' }, + '#withAsDropdown': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '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' } }, + withAsDropdown(value=true): { + asDropdown: value, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon name to be displayed with the link' } }, + withIcon(value): { + icon: value, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current template variables values in the link as query params' } }, + withIncludeVars(value=true): { + includeVars: value, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, includes current time range in the link as query params' } }, + withKeepTime(value=true): { + keepTime: value, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTags(value): { + tags: + (if std.isArray(value) + then value + else [value]), + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of tags to limit the linked dashboards. If empty, all dashboards will be displayed. Only valid if the type is dashboards' } }, + withTagsMixin(value): { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetBlank': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true, the link will be opened in a new tab' } }, + withTargetBlank(value=true): { + targetBlank: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Title to display with the link' } }, + withTitle(value): { + title: value, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Tooltip to display when the user hovers their mouse over it' } }, + withTooltip(value): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['link', 'dashboards'], name: 'value', type: ['string'] }], help: 'Dashboard Link type. Accepted values are dashboards (to refer to another dashboard) and link (to refer to an external resource)' } }, + withType(value): { + type: value, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Link URL. Only required/valid if the type is link' } }, + withUrl(value): { + url: value, + }, + }, + }, + queryOptions+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum number of data points that the panel queries are retrieving.' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables.\nThis value must be formatted as a number followed by a valid time\nidentifier like: "40s", "3d", etc.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withInterval(value): { + interval: value, + }, + '#withQueryCachingTTL': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Overrides the data source configured time-to-live for a query cache item in milliseconds' } }, + withQueryCachingTTL(value): { + queryCachingTTL: value, + }, + '#withTimeFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the relative time range for individual panels,\nwhich causes them to be different than what is selected in\nthe dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different\ntime periods or days on the same dashboard.\nThe value is formatted as time operation like: `now-5m` (Last 5 minutes), `now/d` (the day so far),\n`now-5d/d`(Last 5 days), `now/w` (This week so far), `now-2y/y` (Last 2 years).\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeFrom(value): { + timeFrom: value, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Overrides the time range for individual panels by shifting its start and end relative to the time picker.\nFor example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`.\nNote: Panel time overrides have no effect when the dashboard’s time range is absolute.\nSee: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options' } }, + withTimeShift(value): { + timeShift: value, + }, + '#withHideTimeOverride': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the timeFrom or timeShift overrides are shown in the panel header' } }, + withHideTimeOverride(value=true): { + hideTimeOverride: value, + }, + '#withTargets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargets(value): { + targets: + (if std.isArray(value) + then value + else [value]), + }, + '#withTargetsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Depends on the panel plugin. See the plugin documentation for details.' } }, + withTargetsMixin(value): { + targets+: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformations': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformations(value): { + transformations: + (if std.isArray(value) + then value + else [value]), + }, + '#withTransformationsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of transformations that are applied to the panel data before rendering.\nWhen there are multiple transformations, Grafana applies them in the order they are listed.\nEach transformation creates a result set that then passes on to the next transformation in the processing pipeline.' } }, + withTransformationsMixin(value): { + transformations+: + (if std.isArray(value) + then value + else [value]), + }, + transformation+: + { + '#': { help: '', name: 'transformation' }, + '#withDisabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Disabled transformations are skipped' } }, + withDisabled(value=true): { + disabled: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilter(value): { + filter: value, + }, + '#withFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withFilterMixin(value): { + filter+: value, + }, + filter+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + filter+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + filter+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + filter+: { + options+: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique identifier of transformer' } }, + withId(value): { + id: value, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Options to be passed to the transformer\nValid options depend on the transformer id' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withTopic': { 'function': { args: [{ default: null, enums: ['series', 'annotations', 'alertStates'], name: 'value', type: ['string'] }], help: 'Where to pull DataFrames from as input to transformation' } }, + withTopic(value): { + topic: value, + }, + }, + }, + standardOptions+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit a field should use. The unit you select is applied to all fields except time.\nYou can use the units ID availables in Grafana or a custom unit.\nAvailable units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts\nAs custom unit, you can use the following formats:\n`suffix:` for custom unit that should go after value.\n`prefix:` for custom unit that should go before value.\n`time:` For custom date time formats type for example `time:YYYY-MM-DD`.\n`si:` for custom SI units. For example: `si: mF`. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character.\n`count:` for a custom count unit.\n`currency:` for custom a currency unit.' } }, + withUnit(value): { + fieldConfig+: { + defaults+: { + unit: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + min: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + max: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Specify the number of decimals Grafana includes in the rendered value.\nIf you leave this field blank, Grafana automatically truncates the number of decimals based on the value.\nFor example 1.1234 will display as 1.12 and 100.456 will display as 100.\nTo display all decimals, set the unit to `String`.' } }, + withDecimals(value): { + fieldConfig+: { + defaults+: { + decimals: value, + }, + }, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The display value for this field. This supports template variables blank is auto' } }, + withDisplayName(value): { + fieldConfig+: { + defaults+: { + displayName: value, + }, + }, + }, + color+: + { + '#withFixedColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The fixed color value for fixed or shades color modes.' } }, + withFixedColor(value): { + fieldConfig+: { + defaults+: { + color+: { + fixedColor: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['thresholds', 'palette-classic', 'palette-classic-by-name', 'continuous-GrYlRd', 'continuous-RdYlGr', 'continuous-BlYlRd', 'continuous-YlRd', 'continuous-BlPu', 'continuous-YlBl', 'continuous-blues', 'continuous-reds', 'continuous-greens', 'continuous-purples', 'fixed', 'shades'], name: 'value', type: ['string'] }], help: 'Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value.\nContinuous color interpolates a color using the percentage of a value relative to min and max.\nAccepted values are:\n`thresholds`: From thresholds. Informs Grafana to take the color from the matching threshold\n`palette-classic`: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations\n`palette-classic-by-name`: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations\n`continuous-GrYlRd`: ontinuous Green-Yellow-Red palette mode\n`continuous-RdYlGr`: Continuous Red-Yellow-Green palette mode\n`continuous-BlYlRd`: Continuous Blue-Yellow-Red palette mode\n`continuous-YlRd`: Continuous Yellow-Red palette mode\n`continuous-BlPu`: Continuous Blue-Purple palette mode\n`continuous-YlBl`: Continuous Yellow-Blue palette mode\n`continuous-blues`: Continuous Blue palette mode\n`continuous-reds`: Continuous Red palette mode\n`continuous-greens`: Continuous Green palette mode\n`continuous-purples`: Continuous Purple palette mode\n`shades`: Shades of a single color. Specify a single color, useful in an override rule.\n`fixed`: Fixed color mode. Specify a single color, useful in an override rule.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + color+: { + mode: value, + }, + }, + }, + }, + '#withSeriesBy': { 'function': { args: [{ default: null, enums: ['min', 'max', 'last'], name: 'value', type: ['string'] }], help: 'Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.' } }, + withSeriesBy(value): { + fieldConfig+: { + defaults+: { + color+: { + seriesBy: value, + }, + }, + }, + }, + }, + '#withNoValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alternative to empty string' } }, + withNoValue(value): { + fieldConfig+: { + defaults+: { + noValue: value, + }, + }, + }, + '#withLinks': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinks(value): { + fieldConfig+: { + defaults+: { + links: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withLinksMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The behavior when clicking on a result' } }, + withLinksMixin(value): { + fieldConfig+: { + defaults+: { + links+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappings(value): { + fieldConfig+: { + defaults+: { + mappings: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withMappingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Convert input values into a display string' } }, + withMappingsMixin(value): { + fieldConfig+: { + defaults+: { + mappings+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withOverrides': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverrides(value): { + fieldConfig+: { + overrides: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOverridesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Overrides are the options applied to specific fields overriding the defaults.' } }, + withOverridesMixin(value): { + fieldConfig+: { + overrides+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'True if data source field supports ad-hoc filters' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + filterable: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An explicit path to the field in the datasource. When the frame meta includes a path,\nThis will default to `${frame.meta.path}/${field.name}\n\nWhen defined, this value can be used as an identifier within the datasource scope, and\nmay be used to update the results' } }, + withPath(value): { + fieldConfig+: { + defaults+: { + path: value, + }, + }, + }, + thresholds+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['absolute', 'percentage'], name: 'value', type: ['string'] }], help: 'Thresholds can either be `absolute` (specific number) or `percentage` (relative to min or max, it will be values between 0 and 1).' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + mode: value, + }, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withSteps(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + '#withStepsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: "Must be sorted by 'value', first value is always -Infinity" } }, + withStepsMixin(value): { + fieldConfig+: { + defaults+: { + thresholds+: { + steps+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + mapping+: + { + '#': { help: '', name: 'mapping' }, + ValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }' } }, + withOptionsMixin(value): { + options+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'value', + }, + }, + RangeMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Range to match against and the result to apply when the value is within the range' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Min value of the range. It can be null which means -Infinity' } }, + withFrom(value): { + options+: { + from: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + '#withTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Max value of the range. It can be null which means +Infinity' } }, + withTo(value): { + options+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'range', + }, + }, + RegexMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Regular expression to match against and the result to apply when the value matches the regex' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withPattern': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Regular expression to match against' } }, + withPattern(value): { + options+: { + pattern: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'regex', + }, + }, + SpecialValueMap+: + { + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptions(value): { + options: value, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOptionsMixin(value): { + options+: value, + }, + options+: + { + '#withMatch': { 'function': { args: [{ default: null, enums: ['true', 'false', 'null', 'nan', 'null+nan', 'empty'], name: 'value', type: ['string'] }], help: 'Special value types supported by the `SpecialValueMap`' } }, + withMatch(value): { + options+: { + match: value, + }, + }, + '#withResult': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResult(value): { + options+: { + result: value, + }, + }, + '#withResultMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Result used as replacement with text and color when the value matches' } }, + withResultMixin(value): { + options+: { + result+: value, + }, + }, + result+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to use when the value matches' } }, + withColor(value): { + options+: { + result+: { + color: value, + }, + }, + }, + '#withIcon': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Icon to display when the value matches. Only specific visualizations.' } }, + withIcon(value): { + options+: { + result+: { + icon: value, + }, + }, + }, + '#withIndex': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Position in the mapping array. Only used internally.' } }, + withIndex(value): { + options+: { + result+: { + index: value, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Text to display when the value matches' } }, + withText(value): { + options+: { + result+: { + text: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'special', + }, + }, + }, + threshold+: { + step+: + { + '#': { help: '', name: 'step' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Color represents the color of the visual change that will occur in the dashboard when the threshold value is met or exceeded.' } }, + withColor(value): { + color: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Value represents a specified metric for the threshold, which triggers a visual change in the dashboard when this value is met or exceeded.\nNulls currently appear here when serializing -Infinity to JSON.' } }, + withValue(value): { + value: value, + }, + }, + }, + override+: + { + '#': { help: '', name: 'override' }, + '#withMatcher': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcher(value): { + matcher: value, + }, + '#withMatcherMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation.\nIt comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type.' } }, + withMatcherMixin(value): { + matcher+: value, + }, + matcher+: + { + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: 'The matcher id. This is used to find the matcher implementation from registry.' } }, + withId(value=''): { + matcher+: { + id: value, + }, + }, + '#withOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptions(value): { + matcher+: { + options: value, + }, + }, + '#withOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The matcher options. This is specific to the matcher implementation.' } }, + withOptionsMixin(value): { + matcher+: { + options+: value, + }, + }, + }, + '#withProperties': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withProperties(value): { + properties: + (if std.isArray(value) + then value + else [value]), + }, + '#withPropertiesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPropertiesMixin(value): { + properties+: + (if std.isArray(value) + then value + else [value]), + }, + properties+: + { + '#': { help: '', name: 'properties' }, + '#withId': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value=''): { + id: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withValueMixin(value): { + value+: value, + }, + }, + }, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + libraryPanel+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel name' } }, + withName(value): { + libraryPanel+: { + name: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Library panel uid' } }, + withUid(value): { + libraryPanel+: { + uid: value, + }, + }, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, +} ++ (import 'custom/panel.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/alertList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/alertList.libsonnet new file mode 100644 index 0000000..0865829 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/alertList.libsonnet @@ -0,0 +1,341 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.alertList', name: 'alertList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'alertlist', + }, + }, + options+: + { + '#withAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptions(value): { + options+: { + AlertListOptions: value, + }, + }, + '#withAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAlertListOptionsMixin(value): { + options+: { + AlertListOptions+: value, + }, + }, + AlertListOptions+: + { + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDashboardTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDashboardTitle(value): { + options+: { + dashboardTitle: value, + }, + }, + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowOptions': { 'function': { args: [{ default: null, enums: ['current', 'changes'], name: 'value', type: ['string'] }], help: '' } }, + withShowOptions(value): { + options+: { + showOptions: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withAlerting': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAlerting(value=true): { + options+: { + stateFilter+: { + alerting: value, + }, + }, + }, + '#withExecutionError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withExecutionError(value=true): { + options+: { + stateFilter+: { + execution_error: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + no_data: value, + }, + }, + }, + '#withOk': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOk(value=true): { + options+: { + stateFilter+: { + ok: value, + }, + }, + }, + '#withPaused': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPaused(value=true): { + options+: { + stateFilter+: { + paused: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withUnifiedAlertListOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptions(value): { + options+: { + UnifiedAlertListOptions: value, + }, + }, + '#withUnifiedAlertListOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnifiedAlertListOptionsMixin(value): { + options+: { + UnifiedAlertListOptions+: value, + }, + }, + UnifiedAlertListOptions+: + { + '#withAlertInstanceLabelFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertInstanceLabelFilter(value): { + options+: { + alertInstanceLabelFilter: value, + }, + }, + '#withAlertName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlertName(value): { + options+: { + alertName: value, + }, + }, + '#withDashboardAlerts': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDashboardAlerts(value=true): { + options+: { + dashboardAlerts: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatasource(value): { + options+: { + datasource: value, + }, + }, + '#withFolder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolder(value): { + options+: { + folder: value, + }, + }, + '#withFolderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFolderMixin(value): { + options+: { + folder+: value, + }, + }, + folder+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withId(value): { + options+: { + folder+: { + id: value, + }, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + options+: { + folder+: { + title: value, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + options+: { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + options+: { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupMode': { 'function': { args: [{ default: null, enums: ['default', 'custom'], name: 'value', type: ['string'] }], help: '' } }, + withGroupMode(value): { + options+: { + groupMode: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxItems(value): { + options+: { + maxItems: value, + }, + }, + '#withShowInstances': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowInstances(value=true): { + options+: { + showInstances: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: [1, 2, 3, 4, 5], name: 'value', type: ['number'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withStateFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilter(value): { + options+: { + stateFilter: value, + }, + }, + '#withStateFilterMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStateFilterMixin(value): { + options+: { + stateFilter+: value, + }, + }, + stateFilter+: + { + '#withError': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withError(value=true): { + options+: { + stateFilter+: { + 'error': value, + }, + }, + }, + '#withFiring': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFiring(value=true): { + options+: { + stateFilter+: { + firing: value, + }, + }, + }, + '#withInactive': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInactive(value=true): { + options+: { + stateFilter+: { + inactive: value, + }, + }, + }, + '#withNoData': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNoData(value=true): { + options+: { + stateFilter+: { + noData: value, + }, + }, + }, + '#withNormal': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNormal(value=true): { + options+: { + stateFilter+: { + normal: value, + }, + }, + }, + '#withPending': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPending(value=true): { + options+: { + stateFilter+: { + pending: value, + }, + }, + }, + }, + '#withViewMode': { 'function': { args: [{ default: null, enums: ['list', 'stat'], name: 'value', type: ['string'] }], help: '' } }, + withViewMode(value): { + options+: { + viewMode: value, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/annotationsList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/annotationsList.libsonnet new file mode 100644 index 0000000..ccf1c12 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/annotationsList.libsonnet @@ -0,0 +1,94 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.annotationsList', name: 'annotationsList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'annolist', + }, + }, + options+: + { + '#withLimit': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value=10): { + options+: { + limit: value, + }, + }, + '#withNavigateAfter': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateAfter(value='10m'): { + options+: { + navigateAfter: value, + }, + }, + '#withNavigateBefore': { 'function': { args: [{ default: '10m', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNavigateBefore(value='10m'): { + options+: { + navigateBefore: value, + }, + }, + '#withNavigateToPanel': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withNavigateToPanel(value=true): { + options+: { + navigateToPanel: value, + }, + }, + '#withOnlyFromThisDashboard': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyFromThisDashboard(value=true): { + options+: { + onlyFromThisDashboard: value, + }, + }, + '#withOnlyInTimeRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withOnlyInTimeRange(value=true): { + options+: { + onlyInTimeRange: value, + }, + }, + '#withShowTags': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTags(value=true): { + options+: { + showTags: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withShowUser': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUser(value=true): { + options+: { + showUser: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barChart.libsonnet new file mode 100644 index 0000000..ccba369 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barChart.libsonnet @@ -0,0 +1,553 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barChart', name: 'barChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'barchart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: 'none', enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value='none'): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBarRadius': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Controls the radius of each bar.' } }, + withBarRadius(value=0): { + options+: { + barRadius: value, + }, + }, + '#withBarWidth': { 'function': { args: [{ default: 0.97, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of bars. 1 = Max width, 0 = Min width.' } }, + withBarWidth(value=0.97): { + options+: { + barWidth: value, + }, + }, + '#withColorByField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use the color value for a sibling field to color each bar value.' } }, + withColorByField(value): { + options+: { + colorByField: value, + }, + }, + '#withFullHighlight': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enables mode which highlights the entire bar area and shows tooltip when cursor\nhovers over highlighted area' } }, + withFullHighlight(value=true): { + options+: { + fullHighlight: value, + }, + }, + '#withGroupWidth': { 'function': { args: [{ default: 0.7, enums: null, name: 'value', type: ['number'] }], help: 'Controls the width of groups. 1 = max with, 0 = min width.' } }, + withGroupWidth(value=0.7): { + options+: { + groupWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: 'auto', enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value='auto'): { + options+: { + orientation: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value='auto'): { + options+: { + showValue: value, + }, + }, + '#withStacking': { 'function': { args: [{ default: 'none', enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withStacking(value='none'): { + options+: { + stacking: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Manually select which field from the dataset to represent the x field.' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + '#withXTickLabelMaxLength': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the max length that a label can have before it is truncated.' } }, + withXTickLabelMaxLength(value): { + options+: { + xTickLabelMaxLength: value, + }, + }, + '#withXTickLabelRotation': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the rotation of the x axis labels.' } }, + withXTickLabelRotation(value=0): { + options+: { + xTickLabelRotation: value, + }, + }, + '#withXTickLabelSpacing': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the spacing between x axis labels.\nnegative values indicate backwards skipping behavior' } }, + withXTickLabelSpacing(value=0): { + options+: { + xTickLabelSpacing: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barGauge.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barGauge.libsonnet new file mode 100644 index 0000000..837d4ff --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/barGauge.libsonnet @@ -0,0 +1,269 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.barGauge', name: 'barGauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bargauge', + }, + }, + options+: + { + '#withDisplayMode': { 'function': { args: [{ default: 'gradient', enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withDisplayMode(value='gradient'): { + options+: { + displayMode: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMaxVizHeight': { 'function': { args: [{ default: 300, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxVizHeight(value=300): { + options+: { + maxVizHeight: value, + }, + }, + '#withMinVizHeight': { 'function': { args: [{ default: 16, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=16): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 8, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=8): { + options+: { + minVizWidth: value, + }, + }, + '#withNamePlacement': { 'function': { args: [{ default: 'auto', enums: ['auto', 'top', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge name to be placed explicitly' } }, + withNamePlacement(value='auto'): { + options+: { + namePlacement: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowUnfilled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowUnfilled(value=true): { + options+: { + showUnfilled: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: 'auto', enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value='auto'): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withValueMode': { 'function': { args: [{ default: 'color', enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueMode(value='color'): { + options+: { + valueMode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/candlestick.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/candlestick.libsonnet new file mode 100644 index 0000000..2baf833 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/candlestick.libsonnet @@ -0,0 +1,850 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.candlestick', name: 'candlestick' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'candlestick', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCandleStyle': { 'function': { args: [{ default: 'candles', enums: ['candles', 'ohlcbars'], name: 'value', type: ['string'] }], help: 'Sets the style of the candlesticks' } }, + withCandleStyle(value='candles'): { + options+: { + candleStyle: value, + }, + }, + '#withColorStrategy': { 'function': { args: [{ default: 'open-close', enums: ['open-close', 'close-close'], name: 'value', type: ['string'] }], help: 'Sets the color strategy for the candlesticks' } }, + withColorStrategy(value='open-close'): { + options+: { + colorStrategy: value, + }, + }, + '#withColors': { 'function': { args: [{ default: { down: 'red', flat: 'gray', up: 'green' }, enums: null, name: 'value', type: ['object'] }], help: 'Set which colors are used when the price movement is up or down' } }, + withColors(value={ down: 'red', flat: 'gray', up: 'green' }): { + options+: { + colors: value, + }, + }, + '#withColorsMixin': { 'function': { args: [{ default: { down: 'red', flat: 'gray', up: 'green' }, enums: null, name: 'value', type: ['object'] }], help: 'Set which colors are used when the price movement is up or down' } }, + withColorsMixin(value): { + options+: { + colors+: value, + }, + }, + colors+: + { + '#withDown': { 'function': { args: [{ default: 'red', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDown(value='red'): { + options+: { + colors+: { + down: value, + }, + }, + }, + '#withFlat': { 'function': { args: [{ default: 'gray', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFlat(value='gray'): { + options+: { + colors+: { + flat: value, + }, + }, + }, + '#withUp': { 'function': { args: [{ default: 'green', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUp(value='green'): { + options+: { + colors+: { + up: value, + }, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFields(value): { + options+: { + fields: value, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Map fields to appropriate dimension' } }, + withFieldsMixin(value): { + options+: { + fields+: value, + }, + }, + fields+: + { + '#withClose': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the final (end) value of the given period' } }, + withClose(value): { + options+: { + fields+: { + close: value, + }, + }, + }, + '#withHigh': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the highest value of the given period' } }, + withHigh(value): { + options+: { + fields+: { + high: value, + }, + }, + }, + '#withLow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the lowest value of the given period' } }, + withLow(value): { + options+: { + fields+: { + low: value, + }, + }, + }, + '#withOpen': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the starting value of the given period' } }, + withOpen(value): { + options+: { + fields+: { + open: value, + }, + }, + }, + '#withVolume': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Corresponds to the sample count in the given period. (e.g. number of trades)' } }, + withVolume(value): { + options+: { + fields+: { + volume: value, + }, + }, + }, + }, + '#withIncludeAllFields': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'When enabled, all fields will be sent to the graph' } }, + withIncludeAllFields(value=true): { + options+: { + includeAllFields: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: 'candles+volume', enums: ['candles+volume', 'candles', 'volume'], name: 'value', type: ['string'] }], help: 'Sets which dimensions are used for the visualization' } }, + withMode(value='candles+volume'): { + options+: { + mode: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/canvas.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/canvas.libsonnet new file mode 100644 index 0000000..2cf777f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/canvas.libsonnet @@ -0,0 +1,544 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.canvas', name: 'canvas' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'canvas', + }, + }, + options+: + { + '#withInfinitePan': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable infinite pan' } }, + withInfinitePan(value=true): { + options+: { + infinitePan: value, + }, + }, + '#withInlineEditing': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable inline editing' } }, + withInlineEditing(value=true): { + options+: { + inlineEditing: value, + }, + }, + '#withPanZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable pan and zoom' } }, + withPanZoom(value=true): { + options+: { + panZoom: value, + }, + }, + '#withRoot': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRoot(value): { + options+: { + root: value, + }, + }, + '#withRootMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The root element of canvas (frame), where all canvas elements are nested\nTODO: Figure out how to define a default value for this' } }, + withRootMixin(value): { + options+: { + root+: value, + }, + }, + root+: + { + '#withElements': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElements(value): { + options+: { + root+: { + elements: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withElementsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'The list of canvas elements attached to the root element' } }, + withElementsMixin(value): { + options+: { + root+: { + elements+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + elements+: + { + '#': { help: '', name: 'elements' }, + '#withBackground': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackground(value): { + background: value, + }, + '#withBackgroundMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBackgroundMixin(value): { + background+: value, + }, + background+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + background+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + background+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + background+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withImage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImage(value): { + background+: { + image: value, + }, + }, + '#withImageMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Links to a resource (image/svg path)' } }, + withImageMixin(value): { + background+: { + image+: value, + }, + }, + image+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + background+: { + image+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + background+: { + image+: { + fixed: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'mapping'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + background+: { + image+: { + mode: value, + }, + }, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: ['original', 'contain', 'cover', 'fill', 'tile'], name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + background+: { + size: value, + }, + }, + }, + '#withBorder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorder(value): { + border: value, + }, + '#withBorderMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBorderMixin(value): { + border+: value, + }, + border+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + border+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + border+: { + color+: value, + }, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + border+: { + color+: { + field: value, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + border+: { + color+: { + fixed: value, + }, + }, + }, + }, + '#withRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRadius(value): { + border+: { + radius: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + border+: { + width: value, + }, + }, + }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define this (element config(s))' } }, + withConfigMixin(value): { + config+: value, + }, + '#withConnections': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnections(value): { + connections: + (if std.isArray(value) + then value + else [value]), + }, + '#withConnectionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConnectionsMixin(value): { + connections+: + (if std.isArray(value) + then value + else [value]), + }, + connections+: + { + '#': { help: '', name: 'connections' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColor(value): { + color: value, + }, + '#withColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withColorMixin(value): { + color+: value, + }, + color+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + color+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + color+: { + fixed: value, + }, + }, + }, + '#withPath': { 'function': { args: [{ default: null, enums: ['straight'], name: 'value', type: ['string'] }], help: '' } }, + withPath(value): { + path: value, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSize(value): { + size: value, + }, + '#withSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSizeMixin(value): { + size+: value, + }, + size+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + size+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + size+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + size+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + size+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '| *"linear"' } }, + withMode(value): { + size+: { + mode: value, + }, + }, + }, + '#withSource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSource(value): { + source: value, + }, + '#withSourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceMixin(value): { + source+: value, + }, + source+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + source+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + source+: { + y: value, + }, + }, + }, + '#withSourceOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginal(value): { + sourceOriginal: value, + }, + '#withSourceOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSourceOriginalMixin(value): { + sourceOriginal+: value, + }, + sourceOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + sourceOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + sourceOriginal+: { + y: value, + }, + }, + }, + '#withTarget': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTarget(value): { + target: value, + }, + '#withTargetMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetMixin(value): { + target+: value, + }, + target+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + target+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + target+: { + y: value, + }, + }, + }, + '#withTargetName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTargetName(value): { + targetName: value, + }, + '#withTargetOriginal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginal(value): { + targetOriginal: value, + }, + '#withTargetOriginalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTargetOriginalMixin(value): { + targetOriginal+: value, + }, + targetOriginal+: + { + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + targetOriginal+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + targetOriginal+: { + y: value, + }, + }, + }, + '#withVertices': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVertices(value): { + vertices: + (if std.isArray(value) + then value + else [value]), + }, + '#withVerticesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withVerticesMixin(value): { + vertices+: + (if std.isArray(value) + then value + else [value]), + }, + vertices+: + { + '#': { help: '', name: 'vertices' }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + }, + '#withConstraint': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraint(value): { + constraint: value, + }, + '#withConstraintMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConstraintMixin(value): { + constraint+: value, + }, + constraint+: + { + '#withHorizontal': { 'function': { args: [{ default: null, enums: ['left', 'right', 'leftright', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withHorizontal(value): { + constraint+: { + horizontal: value, + }, + }, + '#withVertical': { 'function': { args: [{ default: null, enums: ['top', 'bottom', 'topbottom', 'center', 'scale'], name: 'value', type: ['string'] }], help: '' } }, + withVertical(value): { + constraint+: { + vertical: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacement(value): { + placement: value, + }, + '#withPlacementMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPlacementMixin(value): { + placement+: value, + }, + placement+: + { + '#withBottom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBottom(value): { + placement+: { + bottom: value, + }, + }, + '#withHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withHeight(value): { + placement+: { + height: value, + }, + }, + '#withLeft': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLeft(value): { + placement+: { + left: value, + }, + }, + '#withRight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRight(value): { + placement+: { + right: value, + }, + }, + '#withRotation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withRotation(value): { + placement+: { + rotation: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTop(value): { + placement+: { + top: value, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + placement+: { + width: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the root element' } }, + withName(value): { + options+: { + root+: { + name: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: 'Type of root element (frame)' } }, + withType(): { + options+: { + root+: { + type: 'frame', + }, + }, + }, + }, + '#withShowAdvancedTypes': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show all available element types' } }, + withShowAdvancedTypes(value=true): { + options+: { + showAdvancedTypes: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/dashboardList.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/dashboardList.libsonnet new file mode 100644 index 0000000..48d9cdd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/dashboardList.libsonnet @@ -0,0 +1,106 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.dashboardList', name: 'dashboardList' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'dashlist', + }, + }, + options+: + { + '#withFolderId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'folderId is deprecated, and migrated to folderUid on panel init' } }, + withFolderId(value): { + options+: { + folderId: value, + }, + }, + '#withFolderUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFolderUID(value): { + options+: { + folderUID: value, + }, + }, + '#withIncludeVars': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIncludeVars(value=true): { + options+: { + includeVars: value, + }, + }, + '#withKeepTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withKeepTime(value=true): { + options+: { + keepTime: value, + }, + }, + '#withMaxItems': { 'function': { args: [{ default: 10, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxItems(value=10): { + options+: { + maxItems: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value=''): { + options+: { + query: value, + }, + }, + '#withShowFolderNames': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowFolderNames(value=true): { + options+: { + showFolderNames: value, + }, + }, + '#withShowHeadings': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowHeadings(value=true): { + options+: { + showHeadings: value, + }, + }, + '#withShowRecentlyViewed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowRecentlyViewed(value=true): { + options+: { + showRecentlyViewed: value, + }, + }, + '#withShowSearch': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowSearch(value=true): { + options+: { + showSearch: value, + }, + }, + '#withShowStarred': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowStarred(value=true): { + options+: { + showStarred: value, + }, + }, + '#withTags': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTags(value): { + options+: { + tags: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTagsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTagsMixin(value): { + options+: { + tags+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/datagrid.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/datagrid.libsonnet new file mode 100644 index 0000000..c93f787 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/datagrid.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.datagrid', name: 'datagrid' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'datagrid', + }, + }, + options+: + { + '#withSelectedSeries': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSelectedSeries(value=0): { + options+: { + selectedSeries: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/debug.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/debug.libsonnet new file mode 100644 index 0000000..3cc3f99 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/debug.libsonnet @@ -0,0 +1,67 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.debug', name: 'debug' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'debug', + }, + }, + options+: + { + '#withCounters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCounters(value): { + options+: { + counters: value, + }, + }, + '#withCountersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCountersMixin(value): { + options+: { + counters+: value, + }, + }, + counters+: + { + '#withDataChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withDataChanged(value=true): { + options+: { + counters+: { + dataChanged: value, + }, + }, + }, + '#withRender': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRender(value=true): { + options+: { + counters+: { + render: value, + }, + }, + }, + '#withSchemaChanged': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSchemaChanged(value=true): { + options+: { + counters+: { + schemaChanged: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['render', 'events', 'cursor', 'State', 'ThrowError'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/gauge.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/gauge.libsonnet new file mode 100644 index 0000000..f627a73 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/gauge.libsonnet @@ -0,0 +1,150 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.gauge', name: 'gauge' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'gauge', + }, + }, + options+: + { + '#withMinVizHeight': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizHeight(value=75): { + options+: { + minVizHeight: value, + }, + }, + '#withMinVizWidth': { 'function': { args: [{ default: 75, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinVizWidth(value=75): { + options+: { + minVizWidth: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowThresholdLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdLabels(value=true): { + options+: { + showThresholdLabels: value, + }, + }, + '#withShowThresholdMarkers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowThresholdMarkers(value=true): { + options+: { + showThresholdMarkers: value, + }, + }, + '#withSizing': { 'function': { args: [{ default: 'auto', enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Allows for the bar gauge size to be set explicitly' } }, + withSizing(value='auto'): { + options+: { + sizing: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/geomap.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/geomap.libsonnet new file mode 100644 index 0000000..61dcd96 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/geomap.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.geomap', name: 'geomap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geomap', + }, + }, + options+: + { + '#withBasemap': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemap(value): { + options+: { + basemap: value, + }, + }, + '#withBasemapMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBasemapMixin(value): { + options+: { + basemap+: value, + }, + }, + basemap+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + options+: { + basemap+: { + config: value, + }, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + options+: { + basemap+: { + config+: value, + }, + }, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + options+: { + basemap+: { + filterData: value, + }, + }, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + options+: { + basemap+: { + filterData+: value, + }, + }, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Common method to define geometry fields' } }, + withLocation(value): { + options+: { + basemap+: { + location: value, + }, + }, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Common method to define geometry fields' } }, + withLocationMixin(value): { + options+: { + basemap+: { + location+: value, + }, + }, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + options+: { + basemap+: { + location+: { + gazetteer: value, + }, + }, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + options+: { + basemap+: { + location+: { + geohash: value, + }, + }, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + options+: { + basemap+: { + location+: { + latitude: value, + }, + }, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + options+: { + basemap+: { + location+: { + longitude: value, + }, + }, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + options+: { + basemap+: { + location+: { + lookup: value, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + basemap+: { + location+: { + mode: value, + }, + }, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + options+: { + basemap+: { + location+: { + wkt: value, + }, + }, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + options+: { + basemap+: { + name: value, + }, + }, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + options+: { + basemap+: { + opacity: value, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + options+: { + basemap+: { + tooltip: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + options+: { + basemap+: { + type: value, + }, + }, + }, + }, + '#withControls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControls(value): { + options+: { + controls: value, + }, + }, + '#withControlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withControlsMixin(value): { + options+: { + controls+: value, + }, + }, + controls+: + { + '#withMouseWheelZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'let the mouse wheel zoom' } }, + withMouseWheelZoom(value=true): { + options+: { + controls+: { + mouseWheelZoom: value, + }, + }, + }, + '#withShowAttribution': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Lower right' } }, + withShowAttribution(value=true): { + options+: { + controls+: { + showAttribution: value, + }, + }, + }, + '#withShowDebug': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show debug' } }, + withShowDebug(value=true): { + options+: { + controls+: { + showDebug: value, + }, + }, + }, + '#withShowMeasure': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Show measure' } }, + withShowMeasure(value=true): { + options+: { + controls+: { + showMeasure: value, + }, + }, + }, + '#withShowScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Scale options' } }, + withShowScale(value=true): { + options+: { + controls+: { + showScale: value, + }, + }, + }, + '#withShowZoom': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Zoom (upper left)' } }, + withShowZoom(value=true): { + options+: { + controls+: { + showZoom: value, + }, + }, + }, + }, + '#withLayers': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayers(value): { + options+: { + layers: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLayersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withLayersMixin(value): { + options+: { + layers+: + (if std.isArray(value) + then value + else [value]), + }, + }, + layers+: + { + '#': { help: '', name: 'layers' }, + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfig(value): { + config: value, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Custom options depending on the type' } }, + withConfigMixin(value): { + config+: value, + }, + '#withFilterData': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterData(value): { + filterData: value, + }, + '#withFilterDataMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Defines a frame MatcherConfig that may filter data for the given layer' } }, + withFilterDataMixin(value): { + filterData+: value, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Common method to define geometry fields' } }, + withLocation(value): { + location: value, + }, + '#withLocationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Common method to define geometry fields' } }, + withLocationMixin(value): { + location+: value, + }, + location+: + { + '#withGazetteer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Path to Gazetteer' } }, + withGazetteer(value): { + location+: { + gazetteer: value, + }, + }, + '#withGeohash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field mappings' } }, + withGeohash(value): { + location+: { + geohash: value, + }, + }, + '#withLatitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLatitude(value): { + location+: { + latitude: value, + }, + }, + '#withLongitude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLongitude(value): { + location+: { + longitude: value, + }, + }, + '#withLookup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLookup(value): { + location+: { + lookup: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['auto', 'geohash', 'coords', 'lookup'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + location+: { + mode: value, + }, + }, + '#withWkt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWkt(value): { + location+: { + wkt: value, + }, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'configured unique display name' } }, + withName(value): { + name: value, + }, + '#withOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Common properties:\nhttps://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html\nLayer opacity (0-1)' } }, + withOpacity(value): { + opacity: value, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Check tooltip (defaults to true)' } }, + withTooltip(value=true): { + tooltip: value, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + type: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'details'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withView(value): { + options+: { + view: value, + }, + }, + '#withViewMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withViewMixin(value): { + options+: { + view+: value, + }, + }, + view+: + { + '#withAllLayers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAllLayers(value=true): { + options+: { + view+: { + allLayers: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: 'zero', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value='zero'): { + options+: { + view+: { + id: value, + }, + }, + }, + '#withLastOnly': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLastOnly(value=true): { + options+: { + view+: { + lastOnly: value, + }, + }, + }, + '#withLat': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLat(value=0): { + options+: { + view+: { + lat: value, + }, + }, + }, + '#withLayer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLayer(value): { + options+: { + view+: { + layer: value, + }, + }, + }, + '#withLon': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLon(value=0): { + options+: { + view+: { + lon: value, + }, + }, + }, + '#withMaxZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMaxZoom(value): { + options+: { + view+: { + maxZoom: value, + }, + }, + }, + '#withMinZoom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withMinZoom(value): { + options+: { + view+: { + minZoom: value, + }, + }, + }, + '#withPadding': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withPadding(value): { + options+: { + view+: { + padding: value, + }, + }, + }, + '#withShared': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShared(value=true): { + options+: { + view+: { + shared: value, + }, + }, + }, + '#withZoom': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withZoom(value=1): { + options+: { + view+: { + zoom: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/heatmap.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/heatmap.libsonnet new file mode 100644 index 0000000..0f7a870 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/heatmap.libsonnet @@ -0,0 +1,845 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.heatmap', name: 'heatmap' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'heatmap', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCalculate': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the heatmap should be calculated from data' } }, + withCalculate(value=true): { + options+: { + calculate: value, + }, + }, + '#withCalculation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Calculation options for the heatmap' } }, + withCalculation(value): { + options+: { + calculation: value, + }, + }, + '#withCalculationMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Calculation options for the heatmap' } }, + withCalculationMixin(value): { + options+: { + calculation+: value, + }, + }, + calculation+: + { + '#withXBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The number of buckets to use for the xAxis in the heatmap' } }, + withXBuckets(value): { + options+: { + calculation+: { + xBuckets: value, + }, + }, + }, + '#withXBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The number of buckets to use for the xAxis in the heatmap' } }, + withXBucketsMixin(value): { + options+: { + calculation+: { + xBuckets+: value, + }, + }, + }, + xBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: 'Sets the bucket calculation mode' } }, + withMode(value): { + options+: { + calculation+: { + xBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + xBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + xBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + xBuckets+: { + value: value, + }, + }, + }, + }, + }, + '#withYBuckets': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The number of buckets to use for the yAxis in the heatmap' } }, + withYBuckets(value): { + options+: { + calculation+: { + yBuckets: value, + }, + }, + }, + '#withYBucketsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The number of buckets to use for the yAxis in the heatmap' } }, + withYBucketsMixin(value): { + options+: { + calculation+: { + yBuckets+: value, + }, + }, + }, + yBuckets+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['size', 'count'], name: 'value', type: ['string'] }], help: 'Sets the bucket calculation mode' } }, + withMode(value): { + options+: { + calculation+: { + yBuckets+: { + mode: value, + }, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScale(value): { + options+: { + calculation+: { + yBuckets+: { + scale: value, + }, + }, + }, + }, + '#withScaleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleMixin(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: value, + }, + }, + }, + }, + scale+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + calculation+: { + yBuckets+: { + scale+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The number of buckets to use for the axis in the heatmap' } }, + withValue(value): { + options+: { + calculation+: { + yBuckets+: { + value: value, + }, + }, + }, + }, + }, + }, + '#withCellGap': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls gap between cells' } }, + withCellGap(value=1): { + options+: { + cellGap: value, + }, + }, + '#withCellRadius': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls cell radius' } }, + withCellRadius(value): { + options+: { + cellRadius: value, + }, + }, + '#withCellValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValues(value): { + options+: { + cellValues: value, + }, + }, + '#withCellValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls cell value options' } }, + withCellValuesMixin(value): { + options+: { + cellValues+: value, + }, + }, + cellValues+: + { + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for cell values' } }, + withDecimals(value): { + options+: { + cellValues+: { + decimals: value, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the cell value unit' } }, + withUnit(value): { + options+: { + cellValues+: { + unit: value, + }, + }, + }, + }, + '#withColor': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColor(value={ exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }): { + options+: { + color: value, + }, + }, + '#withColorMixin': { 'function': { args: [{ default: { exponent: 0.5, fill: 'dark-orange', reverse: false, scheme: 'Oranges', steps: 64 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls various color options' } }, + withColorMixin(value): { + options+: { + color+: value, + }, + }, + color+: + { + '#withExponent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the exponent when scale is set to exponential' } }, + withExponent(value): { + options+: { + color+: { + exponent: value, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color fill when in opacity mode' } }, + withFill(value): { + options+: { + color+: { + fill: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the color scale' } }, + withMax(value): { + options+: { + color+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the color scale' } }, + withMin(value): { + options+: { + color+: { + min: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['opacity', 'scheme'], name: 'value', type: ['string'] }], help: 'Controls the color mode of the heatmap' } }, + withMode(value): { + options+: { + color+: { + mode: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the color scheme' } }, + withReverse(value=true): { + options+: { + color+: { + reverse: value, + }, + }, + }, + '#withScale': { 'function': { args: [{ default: null, enums: ['linear', 'exponential'], name: 'value', type: ['string'] }], help: 'Controls the color scale of the heatmap' } }, + withScale(value): { + options+: { + color+: { + scale: value, + }, + }, + }, + '#withScheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Controls the color scheme used' } }, + withScheme(value): { + options+: { + color+: { + scheme: value, + }, + }, + }, + '#withSteps': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the number of color steps' } }, + withSteps(value): { + options+: { + color+: { + steps: value, + }, + }, + }, + }, + '#withExemplars': { 'function': { args: [{ default: { color: 'rgba(255,0,255,0.7)' }, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplars(value={ color: 'rgba(255,0,255,0.7)' }): { + options+: { + exemplars: value, + }, + }, + '#withExemplarsMixin': { 'function': { args: [{ default: { color: 'rgba(255,0,255,0.7)' }, enums: null, name: 'value', type: ['object'] }], help: 'Controls exemplar options' } }, + withExemplarsMixin(value): { + options+: { + exemplars+: value, + }, + }, + exemplars+: + { + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the color of the exemplar markers' } }, + withColor(value): { + options+: { + exemplars+: { + color: value, + }, + }, + }, + }, + '#withFilterValues': { 'function': { args: [{ default: { le: 0.000000001 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValues(value={ le: 0.000000001 }): { + options+: { + filterValues: value, + }, + }, + '#withFilterValuesMixin': { 'function': { args: [{ default: { le: 0.000000001 }, enums: null, name: 'value', type: ['object'] }], help: 'Controls the value filter range' } }, + withFilterValuesMixin(value): { + options+: { + filterValues+: value, + }, + }, + filterValues+: + { + '#withGe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values greater than or equal to the given value' } }, + withGe(value): { + options+: { + filterValues+: { + ge: value, + }, + }, + }, + '#withLe': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the filter range to values less than or equal to the given value' } }, + withLe(value): { + options+: { + filterValues+: { + le: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: { show: true }, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegend(value={ show: true }): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: { show: true }, enums: null, name: 'value', type: ['object'] }], help: 'Controls legend options' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the legend is shown' } }, + withShow(value=true): { + options+: { + legend+: { + show: value, + }, + }, + }, + }, + '#withRowsFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrame(value): { + options+: { + rowsFrame: value, + }, + }, + '#withRowsFrameMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls frame rows options' } }, + withRowsFrameMixin(value): { + options+: { + rowsFrame+: value, + }, + }, + rowsFrame+: + { + '#withLayout': { 'function': { args: [{ default: null, enums: ['le', 'ge', 'unknown', 'auto'], name: 'value', type: ['string'] }], help: 'Controls tick alignment when not calculating from data' } }, + withLayout(value): { + options+: { + rowsFrame+: { + layout: value, + }, + }, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the name of the cell when not calculating from data' } }, + withValue(value): { + options+: { + rowsFrame+: { + value: value, + }, + }, + }, + }, + '#withSelectionMode': { 'function': { args: [{ default: 'x', enums: ['x', 'y', 'xy'], name: 'value', type: ['string'] }], help: 'Controls which axis to allow selection on' } }, + withSelectionMode(value='x'): { + options+: { + selectionMode: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value='auto'): { + options+: { + showValue: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Controls tooltip options' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withShowColorScale': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a color scale in header' } }, + withShowColorScale(value=true): { + options+: { + tooltip+: { + showColorScale: value, + }, + }, + }, + '#withYHistogram': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls if the tooltip shows a histogram of the y-axis values' } }, + withYHistogram(value=true): { + options+: { + tooltip+: { + yHistogram: value, + }, + }, + }, + }, + '#withYAxis': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxis(value): { + options+: { + yAxis: value, + }, + }, + '#withYAxisMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration options for the yAxis' } }, + withYAxisMixin(value): { + options+: { + yAxis+: value, + }, + }, + yAxis+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + options+: { + yAxis+: { + axisBorderShow: value, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + options+: { + yAxis+: { + axisCenteredZero: value, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + options+: { + yAxis+: { + axisColorMode: value, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + options+: { + yAxis+: { + axisGridShow: value, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + options+: { + yAxis+: { + axisLabel: value, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + options+: { + yAxis+: { + axisPlacement: value, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + options+: { + yAxis+: { + axisSoftMax: value, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + options+: { + yAxis+: { + axisSoftMin: value, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + options+: { + yAxis+: { + axisWidth: value, + }, + }, + }, + '#withDecimals': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Controls the number of decimals for yAxis values' } }, + withDecimals(value): { + options+: { + yAxis+: { + decimals: value, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the maximum value for the yAxis' } }, + withMax(value): { + options+: { + yAxis+: { + max: value, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Sets the minimum value for the yAxis' } }, + withMin(value): { + options+: { + yAxis+: { + min: value, + }, + }, + }, + '#withReverse': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Reverses the yAxis' } }, + withReverse(value=true): { + options+: { + yAxis+: { + reverse: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + options+: { + yAxis+: { + scaleDistribution: value, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + options+: { + yAxis+: { + scaleDistribution+: value, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + options+: { + yAxis+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + options+: { + yAxis+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + options+: { + yAxis+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the yAxis unit' } }, + withUnit(value): { + options+: { + yAxis+: { + unit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/histogram.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/histogram.libsonnet new file mode 100644 index 0000000..d95f1e7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/histogram.libsonnet @@ -0,0 +1,486 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.histogram', name: 'histogram' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: 80, enums: null, name: 'value', type: ['integer'] }], help: 'Controls the fill opacity of the bars.' } }, + withFillOpacity(value=80): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: 'none', enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value='none'): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: 'Controls line width of the bars.' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withBucketCount': { 'function': { args: [{ default: 30, enums: null, name: 'value', type: ['integer'] }], help: 'Bucket count (approx)' } }, + withBucketCount(value=30): { + options+: { + bucketCount: value, + }, + }, + '#withBucketOffset': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Offset buckets by this amount' } }, + withBucketOffset(value=0): { + options+: { + bucketOffset: value, + }, + }, + '#withBucketSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Size of each bucket' } }, + withBucketSize(value): { + options+: { + bucketSize: value, + }, + }, + '#withCombine': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Combines multiple series into a single histogram' } }, + withCombine(value=true): { + options+: { + combine: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/logs.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/logs.libsonnet new file mode 100644 index 0000000..c418388 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/logs.libsonnet @@ -0,0 +1,178 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.logs', name: 'logs' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + options+: + { + '#withDedupStrategy': { 'function': { args: [{ default: null, enums: ['none', 'exact', 'numbers', 'signature'], name: 'value', type: ['string'] }], help: '' } }, + withDedupStrategy(value): { + options+: { + dedupStrategy: value, + }, + }, + '#withDisplayedFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayedFields(value): { + options+: { + displayedFields: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDisplayedFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayedFieldsMixin(value): { + options+: { + displayedFields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withEnableLogDetails': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnableLogDetails(value=true): { + options+: { + enableLogDetails: value, + }, + }, + '#withIsFilterLabelActive': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withIsFilterLabelActive(value): { + options+: { + isFilterLabelActive: value, + }, + }, + '#withIsFilterLabelActiveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withIsFilterLabelActiveMixin(value): { + options+: { + isFilterLabelActive+: value, + }, + }, + '#withOnClickFilterLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define callbacks' } }, + withOnClickFilterLabel(value): { + options+: { + onClickFilterLabel: value, + }, + }, + '#withOnClickFilterLabelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO: figure out how to define callbacks' } }, + withOnClickFilterLabelMixin(value): { + options+: { + onClickFilterLabel+: value, + }, + }, + '#withOnClickFilterOutLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterOutLabel(value): { + options+: { + onClickFilterOutLabel: value, + }, + }, + '#withOnClickFilterOutLabelMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterOutLabelMixin(value): { + options+: { + onClickFilterOutLabel+: value, + }, + }, + '#withOnClickFilterOutString': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterOutString(value): { + options+: { + onClickFilterOutString: value, + }, + }, + '#withOnClickFilterOutStringMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterOutStringMixin(value): { + options+: { + onClickFilterOutString+: value, + }, + }, + '#withOnClickFilterString': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterString(value): { + options+: { + onClickFilterString: value, + }, + }, + '#withOnClickFilterStringMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickFilterStringMixin(value): { + options+: { + onClickFilterString+: value, + }, + }, + '#withOnClickHideField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickHideField(value): { + options+: { + onClickHideField: value, + }, + }, + '#withOnClickHideFieldMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickHideFieldMixin(value): { + options+: { + onClickHideField+: value, + }, + }, + '#withOnClickShowField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickShowField(value): { + options+: { + onClickShowField: value, + }, + }, + '#withOnClickShowFieldMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOnClickShowFieldMixin(value): { + options+: { + onClickShowField+: value, + }, + }, + '#withPrettifyLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPrettifyLogMessage(value=true): { + options+: { + prettifyLogMessage: value, + }, + }, + '#withShowCommonLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowCommonLabels(value=true): { + options+: { + showCommonLabels: value, + }, + }, + '#withShowLabels': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLabels(value=true): { + options+: { + showLabels: value, + }, + }, + '#withShowLogContextToggle': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLogContextToggle(value=true): { + options+: { + showLogContextToggle: value, + }, + }, + '#withShowTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowTime(value=true): { + options+: { + showTime: value, + }, + }, + '#withSortOrder': { 'function': { args: [{ default: null, enums: ['Descending', 'Ascending'], name: 'value', type: ['string'] }], help: '' } }, + withSortOrder(value): { + options+: { + sortOrder: value, + }, + }, + '#withWrapLogMessage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapLogMessage(value=true): { + options+: { + wrapLogMessage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/news.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/news.libsonnet new file mode 100644 index 0000000..eede487 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/news.libsonnet @@ -0,0 +1,34 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.news', name: 'news' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'news', + }, + }, + options+: + { + '#withFeedUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'empty/missing will default to grafana blog' } }, + withFeedUrl(value): { + options+: { + feedUrl: value, + }, + }, + '#withShowImage': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowImage(value=true): { + options+: { + showImage: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/nodeGraph.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/nodeGraph.libsonnet new file mode 100644 index 0000000..75e183a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/nodeGraph.libsonnet @@ -0,0 +1,118 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.nodeGraph', name: 'nodeGraph' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nodeGraph', + }, + }, + options+: + { + '#withEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdges(value): { + options+: { + edges: value, + }, + }, + '#withEdgesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEdgesMixin(value): { + options+: { + edges+: value, + }, + }, + edges+: + { + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + edges+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + edges+: { + secondaryStatUnit: value, + }, + }, + }, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + options+: { + nodes: value, + }, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + options+: { + nodes+: value, + }, + }, + nodes+: + { + '#withArcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcs(value): { + options+: { + nodes+: { + arcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withArcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Define which fields are shown as part of the node arc (colored circle around the node).' } }, + withArcsMixin(value): { + options+: { + nodes+: { + arcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + arcs+: + { + '#': { help: '', name: 'arcs' }, + '#withColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The color of the arc.' } }, + withColor(value): { + color: value, + }, + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Field from which to get the value. Values should be less than 1, representing fraction of a circle.' } }, + withField(value): { + field: value, + }, + }, + '#withMainStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the main stat to override what ever is set in the data frame.' } }, + withMainStatUnit(value): { + options+: { + nodes+: { + mainStatUnit: value, + }, + }, + }, + '#withSecondaryStatUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unit for the secondary stat to override what ever is set in the data frame.' } }, + withSecondaryStatUnit(value): { + options+: { + nodes+: { + secondaryStatUnit: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/pieChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/pieChart.libsonnet new file mode 100644 index 0000000..9ec5edc --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/pieChart.libsonnet @@ -0,0 +1,380 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.pieChart', name: 'pieChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'piechart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDisplayLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabels(value): { + options+: { + displayLabels: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDisplayLabelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDisplayLabelsMixin(value): { + options+: { + displayLabels+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: null, enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValues(value): { + options+: { + legend+: { + values: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withValuesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withValuesMixin(value): { + options+: { + legend+: { + values+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withPieType': { 'function': { args: [{ default: null, enums: ['pie', 'donut'], name: 'value', type: ['string'] }], help: 'Select the pie chart display style.' } }, + withPieType(value): { + options+: { + pieType: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/row.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/row.libsonnet new file mode 100644 index 0000000..1548d38 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/row.libsonnet @@ -0,0 +1,103 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel.row', name: 'row' }, + '#withCollapsed': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Whether this row should be collapsed or not.' } }, + withCollapsed(value=true): { + collapsed: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withGridPos': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPos(value): { + gridPos: value, + }, + '#withGridPosMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Position and dimensions of a panel in the grid' } }, + withGridPosMixin(value): { + gridPos+: value, + }, + gridPos+: + { + '#withH': { 'function': { args: [{ default: 9, enums: null, name: 'value', type: ['integer'] }], help: 'Panel height. The height is the number of rows from the top edge of the panel.' } }, + withH(value=9): { + gridPos+: { + h: value, + }, + }, + '#withStatic': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: "Whether the panel is fixed within the grid. If true, the panel will not be affected by other panels' interactions" } }, + withStatic(value=true): { + gridPos+: { + static: value, + }, + }, + '#withW': { 'function': { args: [{ default: 12, enums: null, name: 'value', type: ['integer'] }], help: 'Panel width. The width is the number of columns from the left edge of the panel.' } }, + withW(value=12): { + gridPos+: { + w: value, + }, + }, + '#withX': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel x. The x coordinate is the number of columns from the left edge of the grid' } }, + withX(value=0): { + gridPos+: { + x: value, + }, + }, + '#withY': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: 'Panel y. The y coordinate is the number of rows from the top edge of the grid' } }, + withY(value=0): { + gridPos+: { + y: value, + }, + }, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Unique identifier of the panel. Generated by Grafana when creating a new panel. It must be unique within a dashboard, but not globally.' } }, + withId(value): { + id: value, + }, + '#withPanels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanels(value): { + panels: + (if std.isArray(value) + then value + else [value]), + }, + '#withPanelsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPanelsMixin(value): { + panels+: + (if std.isArray(value) + then value + else [value]), + }, + '#withRepeat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of template variable to repeat for.' } }, + withRepeat(value): { + repeat: value, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Row title' } }, + withTitle(value): { + title: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'row', + }, +} ++ (import '../custom/row.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stat.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stat.libsonnet new file mode 100644 index 0000000..e7266c0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stat.libsonnet @@ -0,0 +1,162 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stat', name: 'stat' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'stat', + }, + }, + options+: + { + '#withColorMode': { 'function': { args: [{ default: 'value', enums: ['value', 'background', 'background_solid', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withColorMode(value='value'): { + options+: { + colorMode: value, + }, + }, + '#withGraphMode': { 'function': { args: [{ default: 'area', enums: ['none', 'line', 'area'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGraphMode(value='area'): { + options+: { + graphMode: value, + }, + }, + '#withJustifyMode': { 'function': { args: [{ default: 'auto', enums: ['auto', 'center'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withJustifyMode(value='auto'): { + options+: { + justifyMode: value, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withPercentChangeColorMode': { 'function': { args: [{ default: 'standard', enums: ['standard', 'inverted', 'same_as_value'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPercentChangeColorMode(value='standard'): { + options+: { + percentChangeColorMode: value, + }, + }, + '#withReduceOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptions(value): { + options+: { + reduceOptions: value, + }, + }, + '#withReduceOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withReduceOptionsMixin(value): { + options+: { + reduceOptions+: value, + }, + }, + reduceOptions+: + { + '#withCalcs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcs(value): { + options+: { + reduceOptions+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'When !values, pick one value for the whole field' } }, + withCalcsMixin(value): { + options+: { + reduceOptions+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Which fields to show. By default this is only numeric fields' } }, + withFields(value): { + options+: { + reduceOptions+: { + fields: value, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'if showing all values limit' } }, + withLimit(value): { + options+: { + reduceOptions+: { + limit: value, + }, + }, + }, + '#withValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If true show each row value' } }, + withValues(value=true): { + options+: { + reduceOptions+: { + values: value, + }, + }, + }, + }, + '#withShowPercentChange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowPercentChange(value=true): { + options+: { + showPercentChange: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withText(value): { + options+: { + text: value, + }, + }, + '#withTextMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTextMixin(value): { + options+: { + text+: value, + }, + }, + text+: + { + '#withTitleSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit title text size' } }, + withTitleSize(value): { + options+: { + text+: { + titleSize: value, + }, + }, + }, + '#withValueSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Explicit value text size' } }, + withValueSize(value): { + options+: { + text+: { + valueSize: value, + }, + }, + }, + }, + '#withTextMode': { 'function': { args: [{ default: 'auto', enums: ['auto', 'value', 'value_and_name', 'name', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTextMode(value='auto'): { + options+: { + textMode: value, + }, + }, + '#withWideLayout': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWideLayout(value=true): { + options+: { + wideLayout: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stateTimeline.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stateTimeline.libsonnet new file mode 100644 index 0000000..4ae00a9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/stateTimeline.libsonnet @@ -0,0 +1,304 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.stateTimeline', name: 'stateTimeline' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'state-timeline', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=0): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withAlignValue': { 'function': { args: [{ default: 'left', enums: ['center', 'left', 'right'], name: 'value', type: ['string'] }], help: 'Controls the value alignment in the TimelineChart component' } }, + withAlignValue(value='left'): { + options+: { + alignValue: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withMergeValues': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Merge equal consecutive values' } }, + withMergeValues(value=true): { + options+: { + mergeValues: value, + }, + }, + '#withPerPage': { 'function': { args: [{ default: 20, enums: null, name: 'value', type: ['number'] }], help: 'Enables pagination when > 0' } }, + withPerPage(value=20): { + options+: { + perPage: value, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Controls the row height' } }, + withRowHeight(value=0.9): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value='auto'): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/statusHistory.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/statusHistory.libsonnet new file mode 100644 index 0000000..7d6b8f4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/statusHistory.libsonnet @@ -0,0 +1,292 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.statusHistory', name: 'statusHistory' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'status-history', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withFillOpacity': { 'function': { args: [{ default: 70, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFillOpacity(value=70): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: 1, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value=1): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withColWidth': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Controls the column width' } }, + withColWidth(value=0.9): { + options+: { + colWidth: value, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withRowHeight': { 'function': { args: [{ default: 0.9, enums: null, name: 'value', type: ['number'] }], help: 'Set the height of the rows' } }, + withRowHeight(value=0.9): { + options+: { + rowHeight: value, + }, + }, + '#withShowValue': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowValue(value='auto'): { + options+: { + showValue: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/table.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/table.libsonnet new file mode 100644 index 0000000..d90bd8b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/table.libsonnet @@ -0,0 +1,1358 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.table', name: 'table' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'table', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAlign': { 'function': { args: [{ default: 'auto', enums: ['auto', 'left', 'right', 'center'], name: 'value', type: ['string'] }], help: 'TODO -- should not be table specific!\nTODO docs' } }, + withAlign(value='auto'): { + fieldConfig+: { + defaults+: { + custom+: { + align: value, + }, + }, + }, + }, + '#withCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions: value, + }, + }, + }, + }, + '#withCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: 'Table cell options. Each cell has a display mode\nand other potential options for that display.' } }, + withCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: value, + }, + }, + }, + }, + cellOptions+: + { + '#withTableAutoCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions: value, + }, + }, + }, + }, + }, + '#withTableAutoCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Auto mode table cell options' } }, + withTableAutoCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableAutoCellOptions+: value, + }, + }, + }, + }, + }, + TableAutoCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'auto', + }, + }, + }, + }, + }, + '#withWrapText': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapText(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + wrapText: value, + }, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions: value, + }, + }, + }, + }, + }, + '#withTableSparklineCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Sparkline cell options' } }, + withTableSparklineCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableSparklineCellOptions+: value, + }, + }, + }, + }, + }, + TableSparklineCellOptions+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisBorderShow: value, + }, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisCenteredZero: value, + }, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisColorMode: value, + }, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisGridShow: value, + }, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisLabel: value, + }, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisPlacement: value, + }, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMax: value, + }, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisSoftMin: value, + }, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + axisWidth: value, + }, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barAlignment: value, + }, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barMaxWidth: value, + }, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + barWidthFactor: value, + }, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + drawStyle: value, + }, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillBelowTo: value, + }, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillColor: value, + }, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + fillOpacity: value, + }, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + gradientMode: value, + }, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom: value, + }, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: value, + }, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + }, + '#withHideValue': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHideValue(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + hideValue: value, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + insertNulls: value, + }, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + insertNulls+: value, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineColor: value, + }, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineInterpolation: value, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle: value, + }, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: value, + }, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + lineWidth: value, + }, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointColor: value, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSize: value, + }, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + pointSymbol: value, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution: value, + }, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: value, + }, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + showPoints: value, + }, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls: value, + }, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + spanNulls+: value, + }, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking: value, + }, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: value, + }, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle: value, + }, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: value, + }, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + transform: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'sparkline', + }, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions: value, + }, + }, + }, + }, + }, + '#withTableBarGaugeCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Gauge cell options' } }, + withTableBarGaugeCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableBarGaugeCellOptions+: value, + }, + }, + }, + }, + }, + TableBarGaugeCellOptions+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'lcd', 'gradient'], name: 'value', type: ['string'] }], help: 'Enum expressing the possible display modes\nfor the bar gauge component of Grafana UI' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'gauge', + }, + }, + }, + }, + }, + '#withValueDisplayMode': { 'function': { args: [{ default: null, enums: ['color', 'text', 'hidden'], name: 'value', type: ['string'] }], help: 'Allows for the table cell gauge display type to set the gauge mode.' } }, + withValueDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + valueDisplayMode: value, + }, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColoredBackgroundCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored background cell options' } }, + withTableColoredBackgroundCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColoredBackgroundCellOptions+: value, + }, + }, + }, + }, + }, + TableColoredBackgroundCellOptions+: + { + '#withApplyToRow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withApplyToRow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + applyToRow: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['basic', 'gradient'], name: 'value', type: ['string'] }], help: 'Display mode to the "Colored Background" display\nmode for table cells. Either displays a solid color (basic mode)\nor a gradient.' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + mode: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-background', + }, + }, + }, + }, + }, + '#withWrapText': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapText(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + wrapText: value, + }, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions: value, + }, + }, + }, + }, + }, + '#withTableColorTextCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Colored text cell options' } }, + withTableColorTextCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableColorTextCellOptions+: value, + }, + }, + }, + }, + }, + TableColorTextCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'color-text', + }, + }, + }, + }, + }, + '#withWrapText': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWrapText(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + wrapText: value, + }, + }, + }, + }, + }, + }, + '#withTableImageCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions: value, + }, + }, + }, + }, + }, + '#withTableImageCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableImageCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableImageCellOptions+: value, + }, + }, + }, + }, + }, + TableImageCellOptions+: + { + '#withAlt': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlt(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + alt: value, + }, + }, + }, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTitle(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + title: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'image', + }, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions: value, + }, + }, + }, + }, + }, + '#withTableDataLinksCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Show data links in the cell' } }, + withTableDataLinksCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableDataLinksCellOptions+: value, + }, + }, + }, + }, + }, + TableDataLinksCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'data-links', + }, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptions(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions: value, + }, + }, + }, + }, + }, + '#withTableJsonViewCellOptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Json view cell options' } }, + withTableJsonViewCellOptionsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + TableJsonViewCellOptions+: value, + }, + }, + }, + }, + }, + TableJsonViewCellOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + fieldConfig+: { + defaults+: { + custom+: { + cellOptions+: { + type: 'json-view', + }, + }, + }, + }, + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: null, enums: ['auto', 'color-text', 'color-background', 'color-background-solid', 'gradient-gauge', 'lcd-gauge', 'json-view', 'basic', 'image', 'gauge', 'sparkline', 'data-links', 'custom'], name: 'value', type: ['string'] }], help: "Internally, this is the \"type\" of cell that's being displayed\nin the table such as colored text, JSON, gauge, etc.\nThe color-background-solid, gradient-gauge, and lcd-gauge\nmodes are deprecated in favor of new cell subOptions" } }, + withDisplayMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + displayMode: value, + }, + }, + }, + }, + '#withFilterable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFilterable(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + filterable: value, + }, + }, + }, + }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '?? default is missing or false ??' } }, + withHidden(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hidden: value, + }, + }, + }, + }, + '#withHideHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Hides any header for a column, useful for columns that show some static content or buttons.' } }, + withHideHeader(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideHeader: value, + }, + }, + }, + }, + '#withInspect': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withInspect(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + inspect: value, + }, + }, + }, + }, + '#withMinWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMinWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + minWidth: value, + }, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + width: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withCellHeight': { 'function': { args: [{ default: 'sm', enums: ['sm', 'md', 'lg', 'auto'], name: 'value', type: ['string'] }], help: 'Height of a table cell' } }, + withCellHeight(value='sm'): { + options+: { + cellHeight: value, + }, + }, + '#withFooter': { 'function': { args: [{ default: { countRows: false, reducer: null, show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooter(value={ countRows: false, reducer: null, show: false }): { + options+: { + footer: value, + }, + }, + '#withFooterMixin': { 'function': { args: [{ default: { countRows: false, reducer: null, show: false }, enums: null, name: 'value', type: ['object'] }], help: 'Footer options' } }, + withFooterMixin(value): { + options+: { + footer+: value, + }, + }, + footer+: + { + '#withCountRows': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withCountRows(value=true): { + options+: { + footer+: { + countRows: value, + }, + }, + }, + '#withEnablePagination': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withEnablePagination(value=true): { + options+: { + footer+: { + enablePagination: value, + }, + }, + }, + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + options+: { + footer+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + options+: { + footer+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducer(value): { + options+: { + footer+: { + reducer: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'actually 1 value' } }, + withReducerMixin(value): { + options+: { + footer+: { + reducer+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShow(value=true): { + options+: { + footer+: { + show: value, + }, + }, + }, + }, + '#withFrameIndex': { 'function': { args: [{ default: 0, enums: null, name: 'value', type: ['number'] }], help: 'Represents the index of the selected frame' } }, + withFrameIndex(value=0): { + options+: { + frameIndex: value, + }, + }, + '#withShowHeader': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the panel should show the header' } }, + withShowHeader(value=true): { + options+: { + showHeader: value, + }, + }, + '#withShowTypeIcons': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Controls whether the header should show icons for the column types' } }, + withShowTypeIcons(value=true): { + options+: { + showTypeIcons: value, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortBy(value): { + options+: { + sortBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSortByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Used to control row sorting' } }, + withSortByMixin(value): { + options+: { + sortBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + sortBy+: + { + '#': { help: '', name: 'sortBy' }, + '#withDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag used to indicate descending sort order' } }, + withDesc(value=true): { + desc: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Sets the display name of the field to sort by' } }, + withDisplayName(value): { + displayName: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/text.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/text.libsonnet new file mode 100644 index 0000000..4fbad9f --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/text.libsonnet @@ -0,0 +1,73 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.text', name: 'text' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'text', + }, + }, + options+: + { + '#withCode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCode(value): { + options+: { + code: value, + }, + }, + '#withCodeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCodeMixin(value): { + options+: { + code+: value, + }, + }, + code+: + { + '#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' } }, + withLanguage(value='plaintext'): { + options+: { + code+: { + language: value, + }, + }, + }, + '#withShowLineNumbers': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLineNumbers(value=true): { + options+: { + code+: { + showLineNumbers: value, + }, + }, + }, + '#withShowMiniMap': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowMiniMap(value=true): { + options+: { + code+: { + showMiniMap: value, + }, + }, + }, + }, + '#withContent': { 'function': { args: [{ default: '# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withContent(value='# Title\n\nFor markdown syntax help: [commonmark.org/help](https://commonmark.org/help/)'): { + options+: { + content: value, + }, + }, + '#withMode': { 'function': { args: [{ default: 'markdown', enums: ['html', 'markdown', 'code'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value='markdown'): { + options+: { + mode: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/timeSeries.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/timeSeries.libsonnet new file mode 100644 index 0000000..95f529c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/timeSeries.libsonnet @@ -0,0 +1,756 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.timeSeries', name: 'timeSeries' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'timeseries', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: { calcs: [], displayMode: 'list', placement: 'bottom' }, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value={ calcs: [], displayMode: 'list', placement: 'bottom' }): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: { calcs: [], displayMode: 'list', placement: 'bottom' }, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withOrientation': { 'function': { args: [{ default: null, enums: ['auto', 'vertical', 'horizontal'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withOrientation(value): { + options+: { + orientation: value, + }, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezone(value): { + options+: { + timezone: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTimezoneMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withTimezoneMixin(value): { + options+: { + timezone+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/trend.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/trend.libsonnet new file mode 100644 index 0000000..815aa0e --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/trend.libsonnet @@ -0,0 +1,738 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.trend', name: 'trend' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'trend', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withBarAlignment': { 'function': { args: [{ default: null, enums: [-1, 0, 1], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withBarAlignment(value): { + fieldConfig+: { + defaults+: { + custom+: { + barAlignment: value, + }, + }, + }, + }, + '#withBarMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarMaxWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + barMaxWidth: value, + }, + }, + }, + }, + '#withBarWidthFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withBarWidthFactor(value): { + fieldConfig+: { + defaults+: { + custom+: { + barWidthFactor: value, + }, + }, + }, + }, + '#withDrawStyle': { 'function': { args: [{ default: null, enums: ['line', 'bars', 'points'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withDrawStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + drawStyle: value, + }, + }, + }, + }, + '#withFillBelowTo': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillBelowTo(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillBelowTo: value, + }, + }, + }, + }, + '#withFillColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFillColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillColor: value, + }, + }, + }, + }, + '#withFillOpacity': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFillOpacity(value): { + fieldConfig+: { + defaults+: { + custom+: { + fillOpacity: value, + }, + }, + }, + }, + '#withGradientMode': { 'function': { args: [{ default: null, enums: ['none', 'opacity', 'hue', 'scheme'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withGradientMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + gradientMode: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withInsertNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls: value, + }, + }, + }, + }, + '#withInsertNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: '' } }, + withInsertNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + insertNulls+: value, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineInterpolation': { 'function': { args: [{ default: null, enums: ['linear', 'smooth', 'stepBefore', 'stepAfter'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLineInterpolation(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineInterpolation: value, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSymbol': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPointSymbol(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSymbol: value, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShowPoints': { 'function': { args: [{ default: null, enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withShowPoints(value): { + fieldConfig+: { + defaults+: { + custom+: { + showPoints: value, + }, + }, + }, + }, + '#withSpanNulls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNulls(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls: value, + }, + }, + }, + }, + '#withSpanNullsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['boolean', 'number'] }], help: 'Indicate if null values should be treated as gaps or connected.\nWhen the value is a number, it represents the maximum delta in the\nX axis that should be considered connected. For timeseries, this is milliseconds' } }, + withSpanNullsMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + spanNulls+: value, + }, + }, + }, + }, + '#withStacking': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStacking(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking: value, + }, + }, + }, + }, + '#withStackingMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withStackingMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: value, + }, + }, + }, + }, + stacking+: + { + '#withGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withGroup(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + group: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['none', 'normal', 'percent'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + stacking+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withThresholdsStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle: value, + }, + }, + }, + }, + '#withThresholdsStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withThresholdsStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: value, + }, + }, + }, + }, + thresholdsStyle+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['off', 'line', 'dashed', 'area', 'line+area', 'dashed+area', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + thresholdsStyle+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withTransform': { 'function': { args: [{ default: null, enums: ['constant', 'negative-Y'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withTransform(value): { + fieldConfig+: { + defaults+: { + custom+: { + transform: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + '#withXField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the x field to use (defaults to first number)' } }, + withXField(value): { + options+: { + xField: value, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/xyChart.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/xyChart.libsonnet new file mode 100644 index 0000000..7a1065d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panel/xyChart.libsonnet @@ -0,0 +1,1070 @@ +// This file is generated, do not manually edit. +(import '../panel.libsonnet') ++ { + '#': { help: 'grafonnet.panel.xyChart', name: 'xyChart' }, + panelOptions+: + { + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'xychart', + }, + }, + fieldConfig+: { + defaults+: { + custom+: + { + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisBorderShow: value, + }, + }, + }, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisCenteredZero: value, + }, + }, + }, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisColorMode: value, + }, + }, + }, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + axisGridShow: value, + }, + }, + }, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisLabel: value, + }, + }, + }, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisPlacement: value, + }, + }, + }, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMax: value, + }, + }, + }, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisSoftMin: value, + }, + }, + }, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + axisWidth: value, + }, + }, + }, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom: value, + }, + }, + }, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: value, + }, + }, + }, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + legend: value, + }, + }, + }, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + tooltip: value, + }, + }, + }, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + fieldConfig+: { + defaults+: { + custom+: { + hideFrom+: { + viz: value, + }, + }, + }, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value='auto'): { + fieldConfig+: { + defaults+: { + custom+: { + label: value, + }, + }, + }, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue: value, + }, + }, + }, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: value, + }, + }, + }, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + labelValue+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor: value, + }, + }, + }, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: value, + }, + }, + }, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle: value, + }, + }, + }, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: value, + }, + }, + }, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineStyle+: { + fill: value, + }, + }, + }, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + fieldConfig+: { + defaults+: { + custom+: { + lineWidth: value, + }, + }, + }, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor: value, + }, + }, + }, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: value, + }, + }, + }, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointColor+: { + fixed: value, + }, + }, + }, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize: value, + }, + }, + }, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: value, + }, + }, + }, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + field: value, + }, + }, + }, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + fixed: value, + }, + }, + }, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + max: value, + }, + }, + }, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + min: value, + }, + }, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '| *"linear"' } }, + withMode(value): { + fieldConfig+: { + defaults+: { + custom+: { + pointSize+: { + mode: value, + }, + }, + }, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution: value, + }, + }, + }, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: value, + }, + }, + }, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + linearThreshold: value, + }, + }, + }, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + log: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + fieldConfig+: { + defaults+: { + custom+: { + scaleDistribution+: { + type: value, + }, + }, + }, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: 'points', enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value='points'): { + fieldConfig+: { + defaults+: { + custom+: { + show: value, + }, + }, + }, + }, + }, + }, + }, + options+: + { + '#withDims': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDims(value): { + options+: { + dims: value, + }, + }, + '#withDimsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Configuration for the Table/Auto mode' } }, + withDimsMixin(value): { + options+: { + dims+: value, + }, + }, + dims+: + { + '#withExclude': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExclude(value): { + options+: { + dims+: { + exclude: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExcludeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExcludeMixin(value): { + options+: { + dims+: { + exclude+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withFrame(value): { + options+: { + dims+: { + frame: value, + }, + }, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + options+: { + dims+: { + x: value, + }, + }, + }, + }, + '#withLegend': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegend(value): { + options+: { + legend: value, + }, + }, + '#withLegendMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLegendMixin(value): { + options+: { + legend+: value, + }, + }, + legend+: + { + '#withAsTable': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAsTable(value=true): { + options+: { + legend+: { + asTable: value, + }, + }, + }, + '#withCalcs': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcs(value): { + options+: { + legend+: { + calcs: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withCalcsMixin': { 'function': { args: [{ default: [], enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCalcsMixin(value): { + options+: { + legend+: { + calcs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDisplayMode': { 'function': { args: [{ default: 'list', enums: ['list', 'table', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs\nNote: "hidden" needs to remain as an option for plugins compatibility' } }, + withDisplayMode(value='list'): { + options+: { + legend+: { + displayMode: value, + }, + }, + }, + '#withIsVisible': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withIsVisible(value=true): { + options+: { + legend+: { + isVisible: value, + }, + }, + }, + '#withPlacement': { 'function': { args: [{ default: 'bottom', enums: ['bottom', 'right'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withPlacement(value='bottom'): { + options+: { + legend+: { + placement: value, + }, + }, + }, + '#withShowLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withShowLegend(value=true): { + options+: { + legend+: { + showLegend: value, + }, + }, + }, + '#withSortBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSortBy(value): { + options+: { + legend+: { + sortBy: value, + }, + }, + }, + '#withSortDesc': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSortDesc(value=true): { + options+: { + legend+: { + sortDesc: value, + }, + }, + }, + '#withWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withWidth(value): { + options+: { + legend+: { + width: value, + }, + }, + }, + }, + '#withSeries': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeries(value): { + options+: { + series: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSeriesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Manual Mode' } }, + withSeriesMixin(value): { + options+: { + series+: + (if std.isArray(value) + then value + else [value]), + }, + }, + series+: + { + '#': { help: '', name: 'series' }, + '#withAxisBorderShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisBorderShow(value=true): { + axisBorderShow: value, + }, + '#withAxisCenteredZero': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisCenteredZero(value=true): { + axisCenteredZero: value, + }, + '#withAxisColorMode': { 'function': { args: [{ default: null, enums: ['text', 'series'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisColorMode(value): { + axisColorMode: value, + }, + '#withAxisGridShow': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withAxisGridShow(value=true): { + axisGridShow: value, + }, + '#withAxisLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAxisLabel(value): { + axisLabel: value, + }, + '#withAxisPlacement': { 'function': { args: [{ default: null, enums: ['auto', 'top', 'right', 'bottom', 'left', 'hidden'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withAxisPlacement(value): { + axisPlacement: value, + }, + '#withAxisSoftMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMax(value): { + axisSoftMax: value, + }, + '#withAxisSoftMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisSoftMin(value): { + axisSoftMin: value, + }, + '#withAxisWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withAxisWidth(value): { + axisWidth: value, + }, + '#withFrame': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFrame(value): { + frame: value, + }, + '#withHideFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFrom(value): { + hideFrom: value, + }, + '#withHideFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withHideFromMixin(value): { + hideFrom+: value, + }, + hideFrom+: + { + '#withLegend': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLegend(value=true): { + hideFrom+: { + legend: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withTooltip(value=true): { + hideFrom+: { + tooltip: value, + }, + }, + '#withViz': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withViz(value=true): { + hideFrom+: { + viz: value, + }, + }, + }, + '#withLabel': { 'function': { args: [{ default: 'auto', enums: ['auto', 'never', 'always'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withLabel(value='auto'): { + label: value, + }, + '#withLabelValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValue(value): { + labelValue: value, + }, + '#withLabelValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLabelValueMixin(value): { + labelValue+: value, + }, + labelValue+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + labelValue+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFixed(value): { + labelValue+: { + fixed: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['fixed', 'field', 'template'], name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + labelValue+: { + mode: value, + }, + }, + }, + '#withLineColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColor(value): { + lineColor: value, + }, + '#withLineColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLineColorMixin(value): { + lineColor+: value, + }, + lineColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + lineColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + lineColor+: { + fixed: value, + }, + }, + }, + '#withLineStyle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyle(value): { + lineStyle: value, + }, + '#withLineStyleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withLineStyleMixin(value): { + lineStyle+: value, + }, + lineStyle+: + { + '#withDash': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDash(value): { + lineStyle+: { + dash: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDashMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withDashMixin(value): { + lineStyle+: { + dash+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFill': { 'function': { args: [{ default: null, enums: ['solid', 'dash', 'dot', 'square'], name: 'value', type: ['string'] }], help: '' } }, + withFill(value): { + lineStyle+: { + fill: value, + }, + }, + }, + '#withLineWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLineWidth(value): { + lineWidth: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPointColor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColor(value): { + pointColor: value, + }, + '#withPointColorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointColorMixin(value): { + pointColor+: value, + }, + pointColor+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointColor+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'color value' } }, + withFixed(value): { + pointColor+: { + fixed: value, + }, + }, + }, + '#withPointSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSize(value): { + pointSize: value, + }, + '#withPointSizeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPointSizeMixin(value): { + pointSize+: value, + }, + pointSize+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'fixed: T -- will be added by each element' } }, + withField(value): { + pointSize+: { + field: value, + }, + }, + '#withFixed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withFixed(value): { + pointSize+: { + fixed: value, + }, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + pointSize+: { + max: value, + }, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + pointSize+: { + min: value, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['linear', 'quad'], name: 'value', type: ['string'] }], help: '| *"linear"' } }, + withMode(value): { + pointSize+: { + mode: value, + }, + }, + }, + '#withScaleDistribution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistribution(value): { + scaleDistribution: value, + }, + '#withScaleDistributionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withScaleDistributionMixin(value): { + scaleDistribution+: value, + }, + scaleDistribution+: + { + '#withLinearThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLinearThreshold(value): { + scaleDistribution+: { + linearThreshold: value, + }, + }, + '#withLog': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withLog(value): { + scaleDistribution+: { + log: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['linear', 'log', 'ordinal', 'symlog'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withType(value): { + scaleDistribution+: { + type: value, + }, + }, + }, + '#withShow': { 'function': { args: [{ default: 'points', enums: ['points', 'lines', 'points+lines'], name: 'value', type: ['string'] }], help: '' } }, + withShow(value='points'): { + show: value, + }, + '#withX': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withX(value): { + x: value, + }, + '#withY': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withY(value): { + y: value, + }, + }, + '#withSeriesMapping': { 'function': { args: [{ default: null, enums: ['auto', 'manual'], name: 'value', type: ['string'] }], help: 'Auto is "table" in the UI' } }, + withSeriesMapping(value): { + options+: { + seriesMapping: value, + }, + }, + '#withTooltip': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltip(value): { + options+: { + tooltip: value, + }, + }, + '#withTooltipMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TODO docs' } }, + withTooltipMixin(value): { + options+: { + tooltip+: value, + }, + }, + tooltip+: + { + '#withMaxHeight': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxHeight(value): { + options+: { + tooltip+: { + maxHeight: value, + }, + }, + }, + '#withMaxWidth': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMaxWidth(value): { + options+: { + tooltip+: { + maxWidth: value, + }, + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: ['single', 'multi', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withMode(value): { + options+: { + tooltip+: { + mode: value, + }, + }, + }, + '#withSort': { 'function': { args: [{ default: null, enums: ['asc', 'desc', 'none'], name: 'value', type: ['string'] }], help: 'TODO docs' } }, + withSort(value): { + options+: { + tooltip+: { + sort: value, + }, + }, + }, + }, + }, +} ++ { + panelOptions+: { + '#withType':: { + ignore: true, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panelindex.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panelindex.libsonnet new file mode 100644 index 0000000..cffcdad --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/panelindex.libsonnet @@ -0,0 +1,30 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.panel', name: 'panel' }, + alertList: import 'panel/alertList.libsonnet', + annotationsList: import 'panel/annotationsList.libsonnet', + barChart: import 'panel/barChart.libsonnet', + barGauge: import 'panel/barGauge.libsonnet', + candlestick: import 'panel/candlestick.libsonnet', + canvas: import 'panel/canvas.libsonnet', + dashboardList: import 'panel/dashboardList.libsonnet', + datagrid: import 'panel/datagrid.libsonnet', + debug: import 'panel/debug.libsonnet', + gauge: import 'panel/gauge.libsonnet', + geomap: import 'panel/geomap.libsonnet', + heatmap: import 'panel/heatmap.libsonnet', + histogram: import 'panel/histogram.libsonnet', + logs: import 'panel/logs.libsonnet', + news: import 'panel/news.libsonnet', + nodeGraph: import 'panel/nodeGraph.libsonnet', + pieChart: import 'panel/pieChart.libsonnet', + stat: import 'panel/stat.libsonnet', + stateTimeline: import 'panel/stateTimeline.libsonnet', + statusHistory: import 'panel/statusHistory.libsonnet', + table: import 'panel/table.libsonnet', + text: import 'panel/text.libsonnet', + timeSeries: import 'panel/timeSeries.libsonnet', + trend: import 'panel/trend.libsonnet', + xyChart: import 'panel/xyChart.libsonnet', + row: import 'panel/row.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/preferences.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/preferences.libsonnet new file mode 100644 index 0000000..4fd7743 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/preferences.libsonnet @@ -0,0 +1,117 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.preferences', name: 'preferences' }, + '#withCookiePreferences': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Cookie preferences' } }, + withCookiePreferences(value): { + cookiePreferences: value, + }, + '#withCookiePreferencesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Cookie preferences' } }, + withCookiePreferencesMixin(value): { + cookiePreferences+: value, + }, + cookiePreferences+: + { + '#withAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalytics(value): { + cookiePreferences+: { + analytics: value, + }, + }, + '#withAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAnalyticsMixin(value): { + cookiePreferences+: { + analytics+: value, + }, + }, + '#withFunctional': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctional(value): { + cookiePreferences+: { + functional: value, + }, + }, + '#withFunctionalMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withFunctionalMixin(value): { + cookiePreferences+: { + functional+: value, + }, + }, + '#withPerformance': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformance(value): { + cookiePreferences+: { + performance: value, + }, + }, + '#withPerformanceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPerformanceMixin(value): { + cookiePreferences+: { + performance+: value, + }, + }, + }, + '#withHomeDashboardUID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'UID for the home dashboard' } }, + withHomeDashboardUID(value): { + homeDashboardUID: value, + }, + '#withLanguage': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Selected language (beta)' } }, + withLanguage(value): { + language: value, + }, + '#withNavbar': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Navigation preferences' } }, + withNavbar(value): { + navbar: value, + }, + '#withNavbarMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Navigation preferences' } }, + withNavbarMixin(value): { + navbar+: value, + }, + navbar+: + { + '#withBookmarkUrls': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withBookmarkUrls(value): { + navbar+: { + bookmarkUrls: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withBookmarkUrlsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withBookmarkUrlsMixin(value): { + navbar+: { + bookmarkUrls+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withQueryHistory': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Explore query history preferences' } }, + withQueryHistory(value): { + queryHistory: value, + }, + '#withQueryHistoryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Explore query history preferences' } }, + withQueryHistoryMixin(value): { + queryHistory+: value, + }, + queryHistory+: + { + '#withHomeTab': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "one of: '' | 'query' | 'starred';" } }, + withHomeTab(value): { + queryHistory+: { + homeTab: value, + }, + }, + }, + '#withTheme': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'light, dark, empty is default' } }, + withTheme(value): { + theme: value, + }, + '#withTimezone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The timezone selection\nTODO: this should use the timezone defined in common' } }, + withTimezone(value): { + timezone: value, + }, + '#withWeekStart': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'day of the week (sunday, monday, etc)' } }, + withWeekStart(value): { + weekStart: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/publicdashboard.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/publicdashboard.libsonnet new file mode 100644 index 0000000..200e638 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/publicdashboard.libsonnet @@ -0,0 +1,28 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.publicdashboard', name: 'publicdashboard' }, + '#withAccessToken': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public access token' } }, + withAccessToken(value): { + accessToken: value, + }, + '#withAnnotationsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if annotations are enabled' } }, + withAnnotationsEnabled(value=true): { + annotationsEnabled: value, + }, + '#withDashboardUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Dashboard unique identifier referenced by this public dashboard' } }, + withDashboardUid(value): { + dashboardUid: value, + }, + '#withIsEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the public dashboard is enabled' } }, + withIsEnabled(value=true): { + isEnabled: value, + }, + '#withTimeSelectionEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Flag that indicates if the time range picker is enabled' } }, + withTimeSelectionEnabled(value=true): { + timeSelectionEnabled: value, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Unique public dashboard identifier' } }, + withUid(value): { + uid: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query.libsonnet new file mode 100644 index 0000000..fea2747 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query.libsonnet @@ -0,0 +1,17 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query', name: 'query' }, + athena: import 'query/athena.libsonnet', + azureMonitor: import 'query/azureMonitor.libsonnet', + bigquery: import 'query/bigquery.libsonnet', + cloudWatch: import 'query/cloudWatch.libsonnet', + elasticsearch: import 'query/elasticsearch.libsonnet', + expr: import 'query/expr.libsonnet', + googleCloudMonitoring: import 'query/googleCloudMonitoring.libsonnet', + grafanaPyroscope: import 'query/grafanaPyroscope.libsonnet', + loki: import 'query/loki.libsonnet', + parca: import 'query/parca.libsonnet', + prometheus: import 'query/prometheus.libsonnet', + tempo: import 'query/tempo.libsonnet', + testData: import 'query/testData.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/athena.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/athena.libsonnet new file mode 100644 index 0000000..3ddc5cd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/athena.libsonnet @@ -0,0 +1,100 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.athena', name: 'athena' }, + '#withColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withColumn(value): { + column: value, + }, + '#withConnectionArgs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionArgs(value): { + connectionArgs: value, + }, + '#withConnectionArgsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConnectionArgsMixin(value): { + connectionArgs+: value, + }, + connectionArgs+: + { + '#withCatalog': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCatalog(value='__default'): { + connectionArgs+: { + catalog: value, + }, + }, + '#withDatabase': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDatabase(value='__default'): { + connectionArgs+: { + database: value, + }, + }, + '#withRegion': { 'function': { args: [{ default: '__default', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value='__default'): { + connectionArgs+: { + region: value, + }, + }, + '#withResultReuseEnabled': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withResultReuseEnabled(value=true): { + connectionArgs+: { + resultReuseEnabled: value, + }, + }, + '#withResultReuseMaxAgeInMinutes': { 'function': { args: [{ default: 60, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withResultReuseMaxAgeInMinutes(value=60): { + connectionArgs+: { + resultReuseMaxAgeInMinutes: value, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: [0, 1, 2], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withQueryID': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQueryID(value): { + queryID: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawSQL': { 'function': { args: [{ default: '', enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawSQL(value=''): { + rawSQL: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withTable': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTable(value): { + table: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/azureMonitor.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/azureMonitor.libsonnet new file mode 100644 index 0000000..dfbdb6a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/azureMonitor.libsonnet @@ -0,0 +1,885 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.azureMonitor', name: 'azureMonitor' }, + '#withAzureLogAnalytics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalytics(value): { + azureLogAnalytics: value, + }, + '#withAzureLogAnalyticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Logs sub-query properties' } }, + withAzureLogAnalyticsMixin(value): { + azureLogAnalytics+: value, + }, + azureLogAnalytics+: + { + '#withBasicLogsQuery': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If set to true the query will be run as a basic logs query' } }, + withBasicLogsQuery(value=true): { + azureLogAnalytics+: { + basicLogsQuery: value, + }, + }, + '#withDashboardTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'If set to true the dashboard time range will be used as a filter for the query. Otherwise the query time ranges will be used. Defaults to false.' } }, + withDashboardTime(value=true): { + azureLogAnalytics+: { + dashboardTime: value, + }, + }, + '#withIntersectTime': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated Use dashboardTime instead' } }, + withIntersectTime(value=true): { + azureLogAnalytics+: { + intersectTime: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureLogAnalytics+: { + query: value, + }, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResource(value): { + azureLogAnalytics+: { + resource: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureLogAnalytics+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureLogAnalytics+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as.' } }, + withResultFormat(value): { + azureLogAnalytics+: { + resultFormat: value, + }, + }, + '#withTimeColumn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'If dashboardTime is set to true this value dictates which column the time filter will be applied to. Defaults to the first tables timeSpan column, the first datetime column found, or TimeGenerated' } }, + withTimeColumn(value): { + azureLogAnalytics+: { + timeColumn: value, + }, + }, + '#withWorkspace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Workspace ID. This was removed in Grafana 8, but remains for backwards compat.' } }, + withWorkspace(value): { + azureLogAnalytics+: { + workspace: value, + }, + }, + }, + '#withAzureMonitor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Metrics sub-query properties.' } }, + withAzureMonitor(value): { + azureMonitor: value, + }, + '#withAzureMonitorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Monitor Metrics sub-query properties.' } }, + withAzureMonitorMixin(value): { + azureMonitor+: value, + }, + azureMonitor+: + { + '#withAggregation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The aggregation to be used within the query. Defaults to the primaryAggregationType defined by the metric.' } }, + withAggregation(value): { + azureMonitor+: { + aggregation: value, + }, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{ resourceGroup }}. See docs for more detail.' } }, + withAlias(value): { + azureMonitor+: { + alias: value, + }, + }, + '#withAllowedTimeGrainsMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMs(value): { + azureMonitor+: { + allowedTimeGrainsMs: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withAllowedTimeGrainsMsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Time grains that are supported by the metric.' } }, + withAllowedTimeGrainsMsMixin(value): { + azureMonitor+: { + allowedTimeGrainsMs+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withCustomNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "Used as the value for the metricNamespace property when it's different from the resource namespace." } }, + withCustomNamespace(value): { + azureMonitor+: { + customNamespace: value, + }, + }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimension(value): { + azureMonitor+: { + dimension: value, + }, + }, + '#withDimensionFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated This property was migrated to dimensionFilters and should only be accessed in the migration' } }, + withDimensionFilter(value): { + azureMonitor+: { + dimensionFilter: value, + }, + }, + '#withDimensionFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFilters(value): { + azureMonitor+: { + dimensionFilters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withDimensionFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters to reduce the set of data returned. Dimensions that can be filtered on are defined by the metric.' } }, + withDimensionFiltersMixin(value): { + azureMonitor+: { + dimensionFilters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + dimensionFilters+: + { + '#': { help: '', name: 'dimensionFilters' }, + '#withDimension': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of Dimension to be filtered on.' } }, + withDimension(value): { + dimension: value, + }, + '#withFilter': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated filter is deprecated in favour of filters to support multiselect.' } }, + withFilter(value): { + filter: value, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to match with the filter.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "String denoting the filter operation. Supports 'eq' - equals,'ne' - not equals, 'sw' - starts with. Note that some dimensions may not support all operators." } }, + withOperator(value): { + operator: value, + }, + }, + '#withMetricDefinition': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use metricNamespace instead' } }, + withMetricDefinition(value): { + azureMonitor+: { + metricDefinition: value, + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The metric to query data for within the specified metricNamespace. e.g. UsedCapacity' } }, + withMetricName(value): { + azureMonitor+: { + metricName: value, + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "metricNamespace is used as the resource type (or resource namespace).\nIt's usually equal to the target metric namespace. e.g. microsoft.storage/storageaccounts\nKept the name of the variable as metricNamespace to avoid backward incompatibility issues." } }, + withMetricNamespace(value): { + azureMonitor+: { + metricNamespace: value, + }, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The Azure region containing the resource(s).' } }, + withRegion(value): { + azureMonitor+: { + region: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceGroup(value): { + azureMonitor+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resources instead' } }, + withResourceName(value): { + azureMonitor+: { + resourceName: value, + }, + }, + '#withResourceUri': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Use resourceGroup, resourceName and metricNamespace instead' } }, + withResourceUri(value): { + azureMonitor+: { + resourceUri: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureMonitor+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureMonitor+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + resources+: + { + '#': { help: '', name: 'resources' }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + metricNamespace: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value): { + region: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + resourceName: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + subscription: value, + }, + }, + '#withTimeGrain': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The granularity of data points to be queried. Defaults to auto.' } }, + withTimeGrain(value): { + azureMonitor+: { + timeGrain: value, + }, + }, + '#withTimeGrainUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated' } }, + withTimeGrainUnit(value): { + azureMonitor+: { + timeGrainUnit: value, + }, + }, + '#withTop': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Maximum number of records to return. Defaults to 10.' } }, + withTop(value): { + azureMonitor+: { + top: value, + }, + }, + }, + '#withAzureResourceGraph': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Resource Graph sub-query properties.' } }, + withAzureResourceGraph(value): { + azureResourceGraph: value, + }, + '#withAzureResourceGraphMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Azure Resource Graph sub-query properties.' } }, + withAzureResourceGraphMixin(value): { + azureResourceGraph+: value, + }, + azureResourceGraph+: + { + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure Resource Graph KQL query to be executed.' } }, + withQuery(value): { + azureResourceGraph+: { + query: value, + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as. Defaults to table.' } }, + withResultFormat(value): { + azureResourceGraph+: { + resultFormat: value, + }, + }, + }, + '#withAzureTraces': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTraces(value): { + azureTraces: value, + }, + '#withAzureTracesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Application Insights Traces sub-query properties' } }, + withAzureTracesMixin(value): { + azureTraces+: value, + }, + azureTraces+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFilters(value): { + azureTraces+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters for property values.' } }, + withFiltersMixin(value): { + azureTraces+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Values to filter by.' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + '#withOperation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Comparison operator to use. Either equals or not equals.' } }, + withOperation(value): { + operation: value, + }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Property name, auto-populated based on available traces.' } }, + withProperty(value): { + property: value, + }, + }, + '#withOperationId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Operation ID. Used only for Traces queries.' } }, + withOperationId(value): { + azureTraces+: { + operationId: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'KQL query to be executed.' } }, + withQuery(value): { + azureTraces+: { + query: value, + }, + }, + '#withResources': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResources(value): { + azureTraces+: { + resources: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResourcesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of resource URIs to be queried.' } }, + withResourcesMixin(value): { + azureTraces+: { + resources+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withResultFormat': { 'function': { args: [{ default: null, enums: ['table', 'time_series', 'trace', 'logs'], name: 'value', type: ['string'] }], help: 'Specifies the format results should be returned as.' } }, + withResultFormat(value): { + azureTraces+: { + resultFormat: value, + }, + }, + '#withTraceTypes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypes(value): { + azureTraces+: { + traceTypes: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTraceTypesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Types of events to filter by.' } }, + withTraceTypesMixin(value): { + azureTraces+: { + traceTypes+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withGrafanaTemplateVariableFn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '@deprecated Legacy template variable support.' } }, + withGrafanaTemplateVariableFn(value): { + grafanaTemplateVariableFn: value, + }, + '#withGrafanaTemplateVariableFnMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object', 'object'] }], help: '@deprecated Legacy template variable support.' } }, + withGrafanaTemplateVariableFnMixin(value): { + grafanaTemplateVariableFn+: value, + }, + grafanaTemplateVariableFn+: + { + '#withAppInsightsMetricNameQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery: value, + }, + }, + '#withAppInsightsMetricNameQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsMetricNameQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsMetricNameQuery+: value, + }, + }, + AppInsightsMetricNameQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsMetricNameQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withAppInsightsGroupByQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQuery(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery: value, + }, + }, + '#withAppInsightsGroupByQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withAppInsightsGroupByQueryMixin(value): { + grafanaTemplateVariableFn+: { + AppInsightsGroupByQuery+: value, + }, + }, + AppInsightsGroupByQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'AppInsightsGroupByQuery', + }, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricName(value): { + grafanaTemplateVariableFn+: { + metricName: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withSubscriptionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQuery(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery: value, + }, + }, + '#withSubscriptionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSubscriptionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + SubscriptionsQuery+: value, + }, + }, + SubscriptionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'SubscriptionsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + '#withResourceGroupsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQuery(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery: value, + }, + }, + '#withResourceGroupsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceGroupsQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceGroupsQuery+: value, + }, + }, + ResourceGroupsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceGroupsQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withResourceNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQuery(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery: value, + }, + }, + '#withResourceNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withResourceNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + ResourceNamesQuery+: value, + }, + }, + ResourceNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'ResourceNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamespaceQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery: value, + }, + }, + '#withMetricNamespaceQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamespaceQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamespaceQuery+: value, + }, + }, + MetricNamespaceQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamespaceQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricDefinitionsQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQuery(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery: value, + }, + }, + '#withMetricDefinitionsQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '@deprecated Use MetricNamespaceQuery instead' } }, + withMetricDefinitionsQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricDefinitionsQuery+: value, + }, + }, + MetricDefinitionsQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricDefinitionsQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withMetricNamesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQuery(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery: value, + }, + }, + '#withMetricNamesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetricNamesQueryMixin(value): { + grafanaTemplateVariableFn+: { + MetricNamesQuery+: value, + }, + }, + MetricNamesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'MetricNamesQuery', + }, + }, + '#withMetricNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMetricNamespace(value): { + grafanaTemplateVariableFn+: { + metricNamespace: value, + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceGroup(value): { + grafanaTemplateVariableFn+: { + resourceGroup: value, + }, + }, + '#withResourceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResourceName(value): { + grafanaTemplateVariableFn+: { + resourceName: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withWorkspacesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQuery(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery: value, + }, + }, + '#withWorkspacesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withWorkspacesQueryMixin(value): { + grafanaTemplateVariableFn+: { + WorkspacesQuery+: value, + }, + }, + WorkspacesQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'WorkspacesQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSubscription(value): { + grafanaTemplateVariableFn+: { + subscription: value, + }, + }, + }, + '#withUnknownQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQuery(value): { + grafanaTemplateVariableFn+: { + UnknownQuery: value, + }, + }, + '#withUnknownQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnknownQueryMixin(value): { + grafanaTemplateVariableFn+: { + UnknownQuery+: value, + }, + }, + UnknownQuery+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + grafanaTemplateVariableFn+: { + kind: 'UnknownQuery', + }, + }, + '#withRawQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawQuery(value): { + grafanaTemplateVariableFn+: { + rawQuery: value, + }, + }, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withNamespace(value): { + namespace: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used only for exemplar queries from Prometheus' } }, + withQuery(value): { + query: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRegion(value): { + region: value, + }, + '#withResource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withResource(value): { + resource: value, + }, + '#withResourceGroup': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Template variables params. These exist for backwards compatiblity with legacy template variables.' } }, + withResourceGroup(value): { + resourceGroup: value, + }, + '#withSubscription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Azure subscription containing the resource(s) to be queried.' } }, + withSubscription(value): { + subscription: value, + }, + '#withSubscriptions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptions(value): { + subscriptions: + (if std.isArray(value) + then value + else [value]), + }, + '#withSubscriptionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Subscriptions to be queried via Azure Resource Graph.' } }, + withSubscriptionsMixin(value): { + subscriptions+: + (if std.isArray(value) + then value + else [value]), + }, +} ++ (import '../custom/query/azureMonitor.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/bigquery.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/bigquery.libsonnet new file mode 100644 index 0000000..0d69b7a --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/bigquery.libsonnet @@ -0,0 +1,303 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.bigquery', name: 'bigquery' }, + '#withConvertToUTC': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withConvertToUTC(value=true): { + convertToUTC: value, + }, + '#withDataset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withDataset(value): { + dataset: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + format: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLocation': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLocation(value): { + location: value, + }, + '#withPartitioned': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withPartitioned(value=true): { + partitioned: value, + }, + '#withPartitionedField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPartitionedField(value): { + partitionedField: value, + }, + '#withProject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withProject(value): { + project: value, + }, + '#withQueryPriority': { 'function': { args: [{ default: null, enums: ['INTERACTIVE', 'BATCH'], name: 'value', type: ['string'] }], help: '' } }, + withQueryPriority(value): { + queryPriority: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawQuery': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withRawQuery(value=true): { + rawQuery: value, + }, + '#withRawSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawSql(value): { + rawSql: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSharded': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withSharded(value=true): { + sharded: value, + }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSql(value): { + sql: value, + }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSqlMixin(value): { + sql+: value, + }, + sql+: + { + '#withColumns': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withColumns(value): { + sql+: { + columns: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withColumnsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withColumnsMixin(value): { + sql+: { + columns+: + (if std.isArray(value) + then value + else [value]), + }, + }, + columns+: + { + '#': { help: '', name: 'columns' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'function', + }, + }, + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFrom(value): { + sql+: { + from: value, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupBy(value): { + sql+: { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withGroupByMixin(value): { + sql+: { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + property: value, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + property+: value, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + property+: { + name: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + property+: { + type: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'groupBy', + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLimit(value): { + sql+: { + limit: value, + }, + }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffset(value): { + sql+: { + offset: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderBy(value): { + sql+: { + orderBy: value, + }, + }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOrderByMixin(value): { + sql+: { + orderBy+: value, + }, + }, + orderBy+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + sql+: { + orderBy+: { + property: value, + }, + }, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + sql+: { + orderBy+: { + property+: value, + }, + }, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + orderBy+: { + property+: { + name: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + orderBy+: { + property+: { + type: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + orderBy+: { + type: 'property', + }, + }, + }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: ['ASC', 'DESC'], name: 'value', type: ['string'] }], help: '' } }, + withOrderByDirection(value): { + sql+: { + orderByDirection: value, + }, + }, + '#withWhereString': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'whereJsonTree?: _' } }, + withWhereString(value): { + sql+: { + whereString: value, + }, + }, + }, + '#withTable': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTable(value): { + table: value, + }, + '#withTimeShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeShift(value): { + timeShift: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/cloudWatch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/cloudWatch.libsonnet new file mode 100644 index 0000000..fe411c4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/cloudWatch.libsonnet @@ -0,0 +1,742 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.cloudWatch', name: 'cloudWatch' }, + CloudWatchAnnotationQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withActionPrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Use this parameter to filter the results of the operation to only those alarms\nthat use a certain alarm action. For example, you could specify the ARN of\nan SNS topic to find all alarms that send notifications to that topic.\ne.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`\nbut not match `arn:aws:sns:us-east-1:123456789012:your-app-action`' } }, + withActionPrefix(value): { + actionPrefix: value, + }, + '#withAlarmNamePrefix': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An alarm name prefix. If you specify this parameter, you receive information\nabout all alarms that have names that start with this prefix.\ne.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`' } }, + withAlarmNamePrefix(value): { + alarmNamePrefix: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withPrefixMatching': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix' } }, + withPrefixMatching(value=true): { + prefixMatching: value, + }, + '#withQueryMode': { 'function': { args: [{ default: 'Annotations', enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: 'Whether a query is a Metrics, Logs, or Annotations query' } }, + withQueryMode(value='Annotations'): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchLogsQuery+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The CloudWatch Logs Insights query to execute' } }, + withExpression(value): { + expression: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withLogGroupNames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNames(value): { + logGroupNames: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupNamesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use logGroups' } }, + withLogGroupNamesMixin(value): { + logGroupNames+: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroups(value): { + logGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withLogGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Log groups to query' } }, + withLogGroupsMixin(value): { + logGroups+: + (if std.isArray(value) + then value + else [value]), + }, + logGroups+: + { + '#': { help: '', name: 'logGroups' }, + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AccountId of the log group' } }, + withAccountId(value): { + accountId: value, + }, + '#withAccountLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Label of the log group' } }, + withAccountLabel(value): { + accountLabel: value, + }, + '#withArn': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ARN of the log group' } }, + withArn(value): { + arn: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the log group' } }, + withName(value): { + name: value, + }, + }, + '#withQueryLanguage': { 'function': { args: [{ default: null, enums: ['CWLI', 'SQL', 'PPL'], name: 'value', type: ['string'] }], help: 'Language used for querying logs, can be CWLI, SQL, or PPL. If empty, the default language is CWLI.' } }, + withQueryLanguage(value): { + queryLanguage: value, + }, + '#withQueryMode': { 'function': { args: [{ default: 'Logs', enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: 'Whether a query is a Metrics, Logs, or Annotations query' } }, + withQueryMode(value='Logs'): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the logs' } }, + withRegion(value): { + region: value, + }, + '#withStatsGroups': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroups(value): { + statsGroups: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatsGroupsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Fields to group the results by, this field is automatically populated whenever the query is updated' } }, + withStatsGroupsMixin(value): { + statsGroups+: + (if std.isArray(value) + then value + else [value]), + }, + }, + CloudWatchMetricsQuery+: + { + '#withAccountId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.' } }, + withAccountId(value): { + accountId: value, + }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Deprecated: use label\n@deprecated use label' } }, + withAlias(value): { + alias: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensions(value): { + dimensions: value, + }, + '#withDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.' } }, + withDimensionsMixin(value): { + dimensions+: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Math expression query' } }, + withExpression(value): { + expression: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.' } }, + withId(value): { + id: value, + }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.' } }, + withLabel(value): { + label: value, + }, + '#withMatchExact': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Only show metrics that exactly match all defined dimension names.' } }, + withMatchExact(value=true): { + matchExact: value, + }, + '#withMetricEditorMode': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: 'Whether to use the query builder or code editor to create the query' } }, + withMetricEditorMode(value): { + metricEditorMode: value, + }, + '#withMetricName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the metric' } }, + withMetricName(value): { + metricName: value, + }, + '#withMetricQueryType': { 'function': { args: [{ default: null, enums: [0, 1], name: 'value', type: ['string'] }], help: 'Whether to use a metric search or metric insights query' } }, + withMetricQueryType(value): { + metricQueryType: value, + }, + '#withNamespace': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.' } }, + withNamespace(value): { + namespace: value, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: "The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes" } }, + withPeriod(value): { + period: value, + }, + '#withQueryMode': { 'function': { args: [{ default: 'Metrics', enums: ['Metrics', 'Logs', 'Annotations'], name: 'value', type: ['string'] }], help: 'Whether a query is a Metrics, Logs, or Annotations query' } }, + withQueryMode(value='Metrics'): { + queryMode: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withRegion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'AWS region to query for the metric' } }, + withRegion(value): { + region: value, + }, + '#withSql': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'When the metric query type is set to `Insights` and the `metricEditorMode` is set to `Builder`, this field is used to build up an object representation of a SQL query.' } }, + withSql(value): { + sql: value, + }, + '#withSqlMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'When the metric query type is set to `Insights` and the `metricEditorMode` is set to `Builder`, this field is used to build up an object representation of a SQL query.' } }, + withSqlMixin(value): { + sql+: value, + }, + sql+: + { + '#withFrom': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFrom(value): { + sql+: { + from: value, + }, + }, + '#withFromMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'FROM part of the SQL expression' } }, + withFromMixin(value): { + sql+: { + from+: value, + }, + }, + from+: + { + '#withQueryEditorPropertyExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpression(value): { + sql+: { + from+: { + QueryEditorPropertyExpression: value, + }, + }, + }, + '#withQueryEditorPropertyExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorPropertyExpressionMixin(value): { + sql+: { + from+: { + QueryEditorPropertyExpression+: value, + }, + }, + }, + QueryEditorPropertyExpression+: + { + '#withProperty': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withProperty(value): { + sql+: { + from+: { + property: value, + }, + }, + }, + '#withPropertyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPropertyMixin(value): { + sql+: { + from+: { + property+: value, + }, + }, + }, + property+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + property+: { + name: value, + }, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['string'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + from+: { + property+: { + type: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'property', + }, + }, + }, + }, + '#withQueryEditorFunctionExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpression(value): { + sql+: { + from+: { + QueryEditorFunctionExpression: value, + }, + }, + }, + '#withQueryEditorFunctionExpressionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryEditorFunctionExpressionMixin(value): { + sql+: { + from+: { + QueryEditorFunctionExpression+: value, + }, + }, + }, + QueryEditorFunctionExpression+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + from+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + from+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + from+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + from+: { + type: 'function', + }, + }, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'GROUP BY part of the SQL expression' } }, + withGroupBy(value): { + sql+: { + groupBy: value, + }, + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'GROUP BY part of the SQL expression' } }, + withGroupByMixin(value): { + sql+: { + groupBy+: value, + }, + }, + groupBy+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + groupBy+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + groupBy+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + groupBy+: { + type: value, + }, + }, + }, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'LIMIT part of the SQL expression' } }, + withLimit(value): { + sql+: { + limit: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'ORDER BY part of the SQL expression' } }, + withOrderBy(value): { + sql+: { + orderBy: value, + }, + }, + '#withOrderByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'ORDER BY part of the SQL expression' } }, + withOrderByMixin(value): { + sql+: { + orderBy+: value, + }, + }, + orderBy+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + orderBy+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + orderBy+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + orderBy+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + orderBy+: { + type: 'function', + }, + }, + }, + }, + '#withOrderByDirection': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The sort order of the SQL expression, `ASC` or `DESC`' } }, + withOrderByDirection(value): { + sql+: { + orderByDirection: value, + }, + }, + '#withSelect': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SELECT part of the SQL expression' } }, + withSelect(value): { + sql+: { + select: value, + }, + }, + '#withSelectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SELECT part of the SQL expression' } }, + withSelectMixin(value): { + sql+: { + select+: value, + }, + }, + select+: + { + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + sql+: { + select+: { + name: value, + }, + }, + }, + '#withParameters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParameters(value): { + sql+: { + select+: { + parameters: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withParametersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParametersMixin(value): { + sql+: { + select+: { + parameters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + parameters+: + { + '#': { help: '', name: 'parameters' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'functionParameter', + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + sql+: { + select+: { + type: 'function', + }, + }, + }, + }, + '#withWhere': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'WHERE part of the SQL expression' } }, + withWhere(value): { + sql+: { + where: value, + }, + }, + '#withWhereMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'WHERE part of the SQL expression' } }, + withWhereMixin(value): { + sql+: { + where+: value, + }, + }, + where+: + { + '#withExpressions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressions(value): { + sql+: { + where+: { + expressions: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withExpressionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withExpressionsMixin(value): { + sql+: { + where+: { + expressions+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sql+: { + where+: { + type: value, + }, + }, + }, + }, + }, + '#withSqlExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'When the metric query type is set to `Insights`, this field is used to specify the query string.' } }, + withSqlExpression(value): { + sqlExpression: value, + }, + '#withStatistic': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.' } }, + withStatistic(value): { + statistic: value, + }, + '#withStatistics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatistics(value): { + statistics: + (if std.isArray(value) + then value + else [value]), + }, + '#withStatisticsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '@deprecated use statistic' } }, + withStatisticsMixin(value): { + statistics+: + (if std.isArray(value) + then value + else [value]), + }, + }, +} ++ (import '../custom/query/cloudWatch.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/elasticsearch.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/elasticsearch.libsonnet new file mode 100644 index 0000000..15b634b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/elasticsearch.libsonnet @@ -0,0 +1,1467 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.elasticsearch', name: 'elasticsearch' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alias pattern' } }, + withAlias(value): { + alias: value, + }, + '#withBucketAggs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggs(value): { + bucketAggs: + (if std.isArray(value) + then value + else [value]), + }, + '#withBucketAggsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of bucket aggregations' } }, + withBucketAggsMixin(value): { + bucketAggs+: + (if std.isArray(value) + then value + else [value]), + }, + bucketAggs+: + { + DateHistogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withOffset': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOffset(value): { + settings+: { + offset: value, + }, + }, + '#withTimeZone': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTimeZone(value): { + settings+: { + timeZone: value, + }, + }, + '#withTrimEdges': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withTrimEdges(value): { + settings+: { + trimEdges: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'date_histogram', + }, + }, + Histogram+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInterval(value): { + settings+: { + interval: value, + }, + }, + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'histogram', + }, + }, + Terms+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMinDocCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMinDocCount(value): { + settings+: { + min_doc_count: value, + }, + }, + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: ['desc', 'asc'], name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'terms', + }, + }, + Filters+: + { + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + settings+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + settings+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withLabel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabel(value): { + label: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withQuery(value): { + query: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'filters', + }, + }, + GeoHashGrid+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withPrecision': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecision(value): { + settings+: { + precision: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'geohash_grid', + }, + }, + Nested+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'nested', + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetrics(value): { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'List of metric aggregations' } }, + withMetricsMixin(value): { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + metrics+: + { + Count+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'count', + }, + }, + PipelineMetricAggregation+: + { + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + }, + MetricAggregationWithSettings+: + { + BucketScript+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineVariables': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariables(value): { + pipelineVariables: + (if std.isArray(value) + then value + else [value]), + }, + '#withPipelineVariablesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPipelineVariablesMixin(value): { + pipelineVariables+: + (if std.isArray(value) + then value + else [value]), + }, + pipelineVariables+: + { + '#': { help: '', name: 'pipelineVariables' }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'bucket_script', + }, + }, + CumulativeSum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withFormat(value): { + settings+: { + format: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cumulative_sum', + }, + }, + Derivative+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'derivative', + }, + }, + SerialDiff+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLag(value): { + settings+: { + lag: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'serial_diff', + }, + }, + RawData+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_data', + }, + }, + RawDocument+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withSize': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSize(value): { + settings+: { + size: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'raw_document', + }, + }, + UniqueCount+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPrecisionThreshold': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPrecisionThreshold(value): { + settings+: { + precision_threshold: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'cardinality', + }, + }, + Percentiles+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withPercents': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercents(value): { + settings+: { + percents: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPercentsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPercentsMixin(value): { + settings+: { + percents+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'percentiles', + }, + }, + ExtendedStats+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withMeta': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMeta(value): { + meta: value, + }, + '#withMetaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withMetaMixin(value): { + meta+: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withSigma': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withSigma(value): { + settings+: { + sigma: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'extended_stats', + }, + }, + Min+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'min', + }, + }, + Max+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'max', + }, + }, + Sum+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sum', + }, + }, + Average+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMissing': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMissing(value): { + settings+: { + missing: value, + }, + }, + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'avg', + }, + }, + MovingAverage+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_avg', + }, + }, + MovingFunction+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withPipelineAgg': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPipelineAgg(value): { + pipelineAgg: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withScript': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScript(value): { + settings+: { + script: value, + }, + }, + '#withScriptMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'object'] }], help: '' } }, + withScriptMixin(value): { + settings+: { + script+: value, + }, + }, + script+: + { + '#withInline': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withInline(value): { + settings+: { + script+: { + inline: value, + }, + }, + }, + }, + '#withShift': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withShift(value): { + settings+: { + shift: value, + }, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withWindow(value): { + settings+: { + window: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'moving_fn', + }, + }, + Logs+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLimit(value): { + settings+: { + limit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'logs', + }, + }, + Rate+: + { + '#withField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withField(value): { + field: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withUnit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUnit(value): { + settings+: { + unit: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'rate', + }, + }, + TopMetrics+: + { + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withHide(value=true): { + hide: value, + }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withId(value): { + id: value, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMetrics': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetrics(value): { + settings+: { + metrics: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMetricsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withMetricsMixin(value): { + settings+: { + metrics+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withOrder': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrder(value): { + settings+: { + order: value, + }, + }, + '#withOrderBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withOrderBy(value): { + settings+: { + orderBy: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'top_metrics', + }, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Lucene query' } }, + withQuery(value): { + query: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withTimeField': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of time field' } }, + withTimeField(value): { + timeField: value, + }, +} ++ (import '../custom/query/elasticsearch.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/expr.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/expr.libsonnet new file mode 100644 index 0000000..a073852 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/expr.libsonnet @@ -0,0 +1,960 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.expr', name: 'expr' }, + TypeMath+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'General math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'math', + }, + }, + TypeReduce+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last', 'median'], name: 'value', type: ['string'] }], help: 'The reducer\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` \n - `"median"` ' } }, + withReducer(value): { + reducer: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withSettings': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettings(value): { + settings: value, + }, + '#withSettingsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Reducer Options' } }, + withSettingsMixin(value): { + settings+: value, + }, + settings+: + { + '#withMode': { 'function': { args: [{ default: null, enums: ['dropNN', 'replaceNN'], name: 'value', type: ['string'] }], help: 'Non-number reduce behavior\nPossible enum values:\n - `"dropNN"` Drop non-numbers\n - `"replaceNN"` Replace non-numbers' } }, + withMode(value): { + settings+: { + mode: value, + }, + }, + '#withReplaceWithValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Only valid when mode is replace' } }, + withReplaceWithValue(value): { + settings+: { + replaceWithValue: value, + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'reduce', + }, + }, + TypeResample+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDownsampler': { 'function': { args: [{ default: null, enums: ['sum', 'mean', 'min', 'max', 'count', 'last', 'median'], name: 'value', type: ['string'] }], help: 'The downsample function\nPossible enum values:\n - `"sum"` \n - `"mean"` \n - `"min"` \n - `"max"` \n - `"count"` \n - `"last"` \n - `"median"` ' } }, + withDownsampler(value): { + downsampler: value, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The math expression' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'resample', + }, + '#withUpsampler': { 'function': { args: [{ default: null, enums: ['pad', 'backfilling', 'fillna'], name: 'value', type: ['string'] }], help: 'The upsample function\nPossible enum values:\n - `"pad"` Use the last seen value\n - `"backfilling"` backfill\n - `"fillna"` Do not fill values (nill)' } }, + withUpsampler(value): { + upsampler: value, + }, + '#withWindow': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The time duration' } }, + withWindow(value): { + window: value, + }, + }, + TypeClassicConditions+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperator(value): { + operator: value, + }, + '#withOperatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withOperatorMixin(value): { + operator+: value, + }, + operator+: + { + '#withType': { 'function': { args: [{ default: null, enums: ['and', 'or', 'logic-or'], name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + operator+: { + type: value, + }, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQuery(value): { + query: value, + }, + '#withQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withQueryMixin(value): { + query+: value, + }, + query+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + query+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + query+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducer(value): { + reducer: value, + }, + '#withReducerMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withReducerMixin(value): { + reducer+: value, + }, + reducer+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + reducer+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'classic_conditions', + }, + }, + TypeThreshold+: + { + '#withConditions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditions(value): { + conditions: + (if std.isArray(value) + then value + else [value]), + }, + '#withConditionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Threshold Conditions' } }, + withConditionsMixin(value): { + conditions+: + (if std.isArray(value) + then value + else [value]), + }, + conditions+: + { + '#': { help: '', name: 'conditions' }, + '#withEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluator(value): { + evaluator: value, + }, + '#withEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withEvaluatorMixin(value): { + evaluator+: value, + }, + evaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + evaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + evaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + evaluator+: { + type: value, + }, + }, + }, + '#withLoadedDimensions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensions(value): { + loadedDimensions: value, + }, + '#withLoadedDimensionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withLoadedDimensionsMixin(value): { + loadedDimensions+: value, + }, + '#withUnloadEvaluator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluator(value): { + unloadEvaluator: value, + }, + '#withUnloadEvaluatorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUnloadEvaluatorMixin(value): { + unloadEvaluator+: value, + }, + unloadEvaluator+: + { + '#withParams': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParams(value): { + unloadEvaluator+: { + params: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withParamsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withParamsMixin(value): { + unloadEvaluator+: { + params+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['gt', 'lt', 'within_range', 'outside_range'], name: 'value', type: ['string'] }], help: 'e.g. "gt"' } }, + withType(value): { + unloadEvaluator+: { + type: value, + }, + }, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reference to single query result' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'threshold', + }, + }, + TypeSql+: + { + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withExpression': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withExpression(value): { + expression: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withType': { 'function': { args: [], help: '' } }, + withType(): { + type: 'sql', + }, + }, +} ++ (import '../custom/query/expr.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/googleCloudMonitoring.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/googleCloudMonitoring.libsonnet new file mode 100644 index 0000000..6135c5b --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/googleCloudMonitoring.libsonnet @@ -0,0 +1,308 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.googleCloudMonitoring', name: 'googleCloudMonitoring' }, + '#withAliasBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.' } }, + withAliasBy(value): { + aliasBy: value, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Time interval in milliseconds.' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withPromQLQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQuery(value): { + promQLQuery: value, + }, + '#withPromQLQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'PromQL sub-query properties.' } }, + withPromQLQueryMixin(value): { + promQLQuery+: value, + }, + promQLQuery+: + { + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL expression/query to be executed.' } }, + withExpr(value): { + promQLQuery+: { + expr: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + promQLQuery+: { + projectName: value, + }, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'PromQL min step' } }, + withStep(value): { + promQLQuery+: { + step: value, + }, + }, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSloQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQuery(value): { + sloQuery: value, + }, + '#withSloQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'SLO sub-query properties.' } }, + withSloQueryMixin(value): { + sloQuery+: value, + }, + sloQuery+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + sloQuery+: { + alignmentPeriod: value, + }, + }, + '#withGoal': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'SLO goal value.' } }, + withGoal(value): { + sloQuery+: { + goal: value, + }, + }, + '#withLookbackPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific lookback period for the SLO.' } }, + withLookbackPeriod(value): { + sloQuery+: { + lookbackPeriod: value, + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + sloQuery+: { + perSeriesAligner: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + sloQuery+: { + projectName: value, + }, + }, + '#withSelectorName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'SLO selector.' } }, + withSelectorName(value): { + sloQuery+: { + selectorName: value, + }, + }, + '#withServiceId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the service the SLO is in.' } }, + withServiceId(value): { + sloQuery+: { + serviceId: value, + }, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name for the service the SLO is in.' } }, + withServiceName(value): { + sloQuery+: { + serviceName: value, + }, + }, + '#withSloId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'ID for the SLO.' } }, + withSloId(value): { + sloQuery+: { + sloId: value, + }, + }, + '#withSloName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the SLO.' } }, + withSloName(value): { + sloQuery+: { + sloName: value, + }, + }, + }, + '#withTimeSeriesList': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesList(value): { + timeSeriesList: value, + }, + '#withTimeSeriesListMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series List sub-query properties.' } }, + withTimeSeriesListMixin(value): { + timeSeriesList+: value, + }, + timeSeriesList+: + { + '#withAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withAlignmentPeriod(value): { + timeSeriesList+: { + alignmentPeriod: value, + }, + }, + '#withCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withCrossSeriesReducer(value): { + timeSeriesList+: { + crossSeriesReducer: value, + }, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFilters(value): { + timeSeriesList+: { + filters: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of filters to query data by. Labels that can be filtered on are defined by the metric.' } }, + withFiltersMixin(value): { + timeSeriesList+: { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBys(value): { + timeSeriesList+: { + groupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Array of labels to group data by.' } }, + withGroupBysMixin(value): { + timeSeriesList+: { + groupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withPerSeriesAligner(value): { + timeSeriesList+: { + perSeriesAligner: value, + }, + }, + '#withPreprocessor': { 'function': { args: [{ default: null, enums: ['none', 'rate', 'delta'], name: 'value', type: ['string'] }], help: 'Types of pre-processor available. Defined by the metric.' } }, + withPreprocessor(value): { + timeSeriesList+: { + preprocessor: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesList+: { + projectName: value, + }, + }, + '#withSecondaryAlignmentPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment period to use when regularizing data. Defaults to cloud-monitoring-auto.' } }, + withSecondaryAlignmentPeriod(value): { + timeSeriesList+: { + secondaryAlignmentPeriod: value, + }, + }, + '#withSecondaryCrossSeriesReducer': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Reducer applied across a set of time-series values. Defaults to REDUCE_NONE.' } }, + withSecondaryCrossSeriesReducer(value): { + timeSeriesList+: { + secondaryCrossSeriesReducer: value, + }, + }, + '#withSecondaryGroupBys': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBys(value): { + timeSeriesList+: { + secondaryGroupBys: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryGroupBysMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Only present if a preprocessor is selected. Array of labels to group data by.' } }, + withSecondaryGroupBysMixin(value): { + timeSeriesList+: { + secondaryGroupBys+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withSecondaryPerSeriesAligner': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Only present if a preprocessor is selected. Alignment function to be used. Defaults to ALIGN_MEAN.' } }, + withSecondaryPerSeriesAligner(value): { + timeSeriesList+: { + secondaryPerSeriesAligner: value, + }, + }, + '#withText': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation text.' } }, + withText(value): { + timeSeriesList+: { + text: value, + }, + }, + '#withTitle': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Annotation title.' } }, + withTitle(value): { + timeSeriesList+: { + title: value, + }, + }, + '#withView': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Data view, defaults to FULL.' } }, + withView(value): { + timeSeriesList+: { + view: value, + }, + }, + }, + '#withTimeSeriesQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQuery(value): { + timeSeriesQuery: value, + }, + '#withTimeSeriesQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Time Series sub-query properties.' } }, + withTimeSeriesQueryMixin(value): { + timeSeriesQuery+: value, + }, + timeSeriesQuery+: + { + '#withGraphPeriod': { 'function': { args: [{ default: 'disabled', enums: null, name: 'value', type: ['string'] }], help: "To disable the graphPeriod, it should explictly be set to 'disabled'." } }, + withGraphPeriod(value='disabled'): { + timeSeriesQuery+: { + graphPeriod: value, + }, + }, + '#withProjectName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'GCP project to execute the query against.' } }, + withProjectName(value): { + timeSeriesQuery+: { + projectName: value, + }, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'MQL query to be executed.' } }, + withQuery(value): { + timeSeriesQuery+: { + query: value, + }, + }, + }, +} ++ (import '../custom/query/googleCloudMonitoring.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/grafanaPyroscope.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/grafanaPyroscope.libsonnet new file mode 100644 index 0000000..70c949d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/grafanaPyroscope.libsonnet @@ -0,0 +1,80 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.grafanaPyroscope', name: 'grafanaPyroscope' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Allows to group the results.' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withMaxNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Sets the maximum number of nodes in the flamegraph.' } }, + withMaxNodes(value): { + maxNodes: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSpanSelector': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, + withSpanSelector(value): { + spanSelector: + (if std.isArray(value) + then value + else [value]), + }, + '#withSpanSelectorMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Specifies the query span selectors.' } }, + withSpanSelectorMixin(value): { + spanSelector+: + (if std.isArray(value) + then value + else [value]), + }, +} ++ (import '../custom/query/grafanaPyroscope.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/loki.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/loki.libsonnet new file mode 100644 index 0000000..60f46b0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/loki.libsonnet @@ -0,0 +1,72 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.loki', name: 'loki' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: '' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The LogQL query.' } }, + withExpr(value): { + expr: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withInstant(value=true): { + instant: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to override the name of the series.' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#withMaxLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Used to limit the number of log rows returned.' } }, + withMaxLines(value): { + maxLines: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '@deprecated, now use queryType.' } }, + withRange(value=true): { + range: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withResolution': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '@deprecated, now use step.' } }, + withResolution(value): { + resolution: value, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used to set step value for range queries.' } }, + withStep(value): { + step: value, + }, +} ++ (import '../custom/query/loki.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/parca.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/parca.libsonnet new file mode 100644 index 0000000..c2939fd --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/parca.libsonnet @@ -0,0 +1,48 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.parca', name: 'parca' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLabelSelector': { 'function': { args: [{ default: '{}', enums: null, name: 'value', type: ['string'] }], help: 'Specifies the query label selectors.' } }, + withLabelSelector(value='{}'): { + labelSelector: value, + }, + '#withProfileTypeId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specifies the type of profile to query.' } }, + withProfileTypeId(value): { + profileTypeId: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, +} ++ (import '../custom/query/parca.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/prometheus.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/prometheus.libsonnet new file mode 100644 index 0000000..7ebcdf8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/prometheus.libsonnet @@ -0,0 +1,76 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.prometheus', name: 'prometheus' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withEditorMode': { 'function': { args: [{ default: null, enums: ['code', 'builder'], name: 'value', type: ['string'] }], help: 'Specifies which editor is being used to prepare the query. It can be "code" or "builder"' } }, + withEditorMode(value): { + editorMode: value, + }, + '#withExemplar': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Execute an additional query to identify interesting raw samples relevant for the given expr' } }, + withExemplar(value=true): { + exemplar: value, + }, + '#withExpr': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The actual expression/query that will be evaluated by Prometheus' } }, + withExpr(value): { + expr: value, + }, + '#withFormat': { 'function': { args: [{ default: null, enums: ['time_series', 'table', 'heatmap'], name: 'value', type: ['string'] }], help: 'Query format to determine how to display data points in panel. It can be "time_series", "table", "heatmap"' } }, + withFormat(value): { + format: value, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withInstant': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns only the latest value that Prometheus has scraped for the requested time series' } }, + withInstant(value=true): { + instant: value, + }, + '#withInterval': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'An additional lower limit for the step parameter of the Prometheus query and for the\n`$__interval` and `$__rate_interval` variables.' } }, + withInterval(value): { + interval: value, + }, + '#withIntervalFactor': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '@deprecated Used to specify how many times to divide max data points by. We use max data points under query options\nSee https://github.com/grafana/grafana/issues/48081' } }, + withIntervalFactor(value): { + intervalFactor: value, + }, + '#withLegendFormat': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Series name override or template. Ex. {{hostname}} will be replaced with label value for hostname' } }, + withLegendFormat(value): { + legendFormat: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#withRange': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Returns a Range vector, comprised of a set of time series containing a range of data points over time for each time series' } }, + withRange(value=true): { + range: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, +} ++ (import '../custom/query/prometheus.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/tempo.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/tempo.libsonnet new file mode 100644 index 0000000..42cff36 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/tempo.libsonnet @@ -0,0 +1,184 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.tempo', name: 'tempo' }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withFilters': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFilters(value): { + filters: + (if std.isArray(value) + then value + else [value]), + }, + '#withFiltersMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFiltersMixin(value): { + filters+: + (if std.isArray(value) + then value + else [value]), + }, + filters+: + { + '#': { help: '', name: 'filters' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#withGroupBy': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupBy(value): { + groupBy: + (if std.isArray(value) + then value + else [value]), + }, + '#withGroupByMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'Filters that are used to query the metrics summary' } }, + withGroupByMixin(value): { + groupBy+: + (if std.isArray(value) + then value + else [value]), + }, + groupBy+: + { + '#': { help: '', name: 'groupBy' }, + '#withId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Uniquely identify the filter, will not be used in the query generation' } }, + withId(value): { + id: value, + }, + '#withOperator': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The operator that connects the tag to the value, for example: =, >, !=, =~' } }, + withOperator(value): { + operator: value, + }, + '#withScope': { 'function': { args: [{ default: null, enums: ['intrinsic', 'unscoped', 'resource', 'span'], name: 'value', type: ['string'] }], help: 'static fields are pre-set in the UI, dynamic fields are added by the user' } }, + withScope(value): { + scope: value, + }, + '#withTag': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The tag for the search filter, for example: .http.status_code, .service.name, status' } }, + withTag(value): { + tag: value, + }, + '#withValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValue(value): { + value: value, + }, + '#withValueMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'The value for the search filter' } }, + withValueMixin(value): { + value+: value, + }, + '#withValueType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The type of the value, used for example to check whether we need to wrap the value in quotes when generating the query' } }, + withValueType(value): { + valueType: value, + }, + }, + '#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.' } }, + withHide(value=true): { + hide: value, + }, + '#withLimit': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of traces that are returned from Tempo' } }, + withLimit(value): { + limit: value, + }, + '#withMaxDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the maximum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMaxDuration(value): { + maxDuration: value, + }, + '#withMinDuration': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Define the minimum duration to select traces. Use duration format, for example: 1.2s, 100ms' } }, + withMinDuration(value): { + minDuration: value, + }, + '#withQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'TraceQL query or trace ID' } }, + withQuery(value): { + query: value, + }, + '#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' } }, + withQueryType(value): { + queryType: value, + }, + '#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.' } }, + withRefId(value): { + refId: value, + }, + '#withSearch': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Logfmt query to filter traces by their tags. Example: http.status_code=200 error=true' } }, + withSearch(value): { + search: value, + }, + '#withServiceMapIncludeNamespace': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Use service.namespace in addition to service.name to uniquely identify a service.' } }, + withServiceMapIncludeNamespace(value=true): { + serviceMapIncludeNamespace: value, + }, + '#withServiceMapQuery': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQuery(value): { + serviceMapQuery: value, + }, + '#withServiceMapQueryMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string', 'array'] }], help: 'Filters to be included in a PromQL query to select data for the service graph. Example: {client="app",service="app"}. Providing multiple values will produce union of results for each filter, using PromQL OR operator internally.' } }, + withServiceMapQueryMixin(value): { + serviceMapQuery+: value, + }, + '#withServiceName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by service name' } }, + withServiceName(value): { + serviceName: value, + }, + '#withSpanName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '@deprecated Query traces by span name' } }, + withSpanName(value): { + spanName: value, + }, + '#withSpss': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Defines the maximum number of spans per spanset that are returned from Tempo' } }, + withSpss(value): { + spss: value, + }, + '#withStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'For metric queries, the step size to use' } }, + withStep(value): { + step: value, + }, + '#withTableType': { 'function': { args: [{ default: null, enums: ['traces', 'spans', 'raw'], name: 'value', type: ['string'] }], help: 'The type of the table that is used to display the search results' } }, + withTableType(value): { + tableType: value, + }, +} ++ (import '../custom/query/tempo.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/testData.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/testData.libsonnet new file mode 100644 index 0000000..db81210 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/query/testData.libsonnet @@ -0,0 +1,494 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.query.testData', name: 'testData' }, + '#withAlias': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withAlias(value): { + alias: value, + }, + '#withChannel': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Used for live query' } }, + withChannel(value): { + channel: value, + }, + '#withCsvContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvContent(value): { + csvContent: value, + }, + '#withCsvFileName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withCsvFileName(value): { + csvFileName: value, + }, + '#withCsvWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWave(value): { + csvWave: + (if std.isArray(value) + then value + else [value]), + }, + '#withCsvWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withCsvWaveMixin(value): { + csvWave+: + (if std.isArray(value) + then value + else [value]), + }, + csvWave+: + { + '#': { help: '', name: 'csvWave' }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + timeStep: value, + }, + '#withValuesCSV': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withValuesCSV(value): { + valuesCSV: value, + }, + }, + '#withDatasource': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasource(value): { + datasource: value, + }, + '#withDatasourceMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Ref to a DataSource instance' } }, + withDatasourceMixin(value): { + datasource+: value, + }, + datasource+: + { + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The plugin type-id' } }, + withType(value): { + datasource+: { + type: value, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Specific datasource instance' } }, + withUid(value): { + datasource+: { + uid: value, + }, + }, + }, + '#withDropPercent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Drop percentage (the chance we will lose a point 0-100)' } }, + withDropPercent(value): { + dropPercent: value, + }, + '#withErrorType': { 'function': { args: [{ default: null, enums: ['frontend_exception', 'frontend_observable', 'server_panic'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"frontend_exception"` \n - `"frontend_observable"` \n - `"server_panic"` ' } }, + withErrorType(value): { + errorType: value, + }, + '#withFlamegraphDiff': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withFlamegraphDiff(value=true): { + flamegraphDiff: value, + }, + '#withHide': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)' } }, + withHide(value=true): { + hide: value, + }, + '#withIntervalMs': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: 'Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization' } }, + withIntervalMs(value): { + intervalMs: value, + }, + '#withLabels': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withLabels(value): { + labels: value, + }, + '#withLevelColumn': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLevelColumn(value=true): { + levelColumn: value, + }, + '#withLines': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withLines(value): { + lines: value, + }, + '#withMax': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMax(value): { + max: value, + }, + '#withMaxDataPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization' } }, + withMaxDataPoints(value): { + maxDataPoints: value, + }, + '#withMin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withMin(value): { + min: value, + }, + '#withNodes': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodes(value): { + nodes: value, + }, + '#withNodesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withNodesMixin(value): { + nodes+: value, + }, + nodes+: + { + '#withCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withCount(value): { + nodes+: { + count: value, + }, + }, + '#withSeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeed(value): { + nodes+: { + seed: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['random', 'random edges', 'response_medium', 'response_small', 'feature_showcase'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"random"` \n - `"random edges"` \n - `"response_medium"` \n - `"response_small"` \n - `"feature_showcase"` ' } }, + withType(value): { + nodes+: { + type: value, + }, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + noise: value, + }, + '#withPoints': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPoints(value): { + points: + (if std.isArray(value) + then value + else [value]), + }, + '#withPointsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withPointsMixin(value): { + points+: + (if std.isArray(value) + then value + else [value]), + }, + '#withPulseWave': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWave(value): { + pulseWave: value, + }, + '#withPulseWaveMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withPulseWaveMixin(value): { + pulseWave+: value, + }, + pulseWave+: + { + '#withOffCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOffCount(value): { + pulseWave+: { + offCount: value, + }, + }, + '#withOffValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOffValue(value): { + pulseWave+: { + offValue: value, + }, + }, + '#withOnCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withOnCount(value): { + pulseWave+: { + onCount: value, + }, + }, + '#withOnValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withOnValue(value): { + pulseWave+: { + onValue: value, + }, + }, + '#withTimeStep': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withTimeStep(value): { + pulseWave+: { + timeStep: value, + }, + }, + }, + '#withQueryType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.' } }, + withQueryType(value): { + queryType: value, + }, + '#withRawFrameContent': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withRawFrameContent(value): { + rawFrameContent: value, + }, + '#withRefId': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'RefID is the unique identifier of the query, set by the frontend call.' } }, + withRefId(value): { + refId: value, + }, + '#withResultAssertions': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertions(value): { + resultAssertions: value, + }, + '#withResultAssertionsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'Optionally define expected query result behavior' } }, + withResultAssertionsMixin(value): { + resultAssertions+: value, + }, + resultAssertions+: + { + '#withMaxFrames': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: 'Maximum frame count' } }, + withMaxFrames(value): { + resultAssertions+: { + maxFrames: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['', 'timeseries-wide', 'timeseries-long', 'timeseries-many', 'timeseries-multi', 'directory-listing', 'table', 'numeric-wide', 'numeric-multi', 'numeric-long', 'log-lines'], name: 'value', type: ['string'] }], help: 'Type asserts that the frame matches a known type structure.\nPossible enum values:\n - `""` \n - `"timeseries-wide"` \n - `"timeseries-long"` \n - `"timeseries-many"` \n - `"timeseries-multi"` \n - `"directory-listing"` \n - `"table"` \n - `"numeric-wide"` \n - `"numeric-multi"` \n - `"numeric-long"` \n - `"log-lines"` ' } }, + withType(value): { + resultAssertions+: { + type: value, + }, + }, + '#withTypeVersion': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersion(value): { + resultAssertions+: { + typeVersion: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withTypeVersionMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: 'TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.' } }, + withTypeVersionMixin(value): { + resultAssertions+: { + typeVersion+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withScenarioId': { 'function': { args: [{ default: null, enums: ['annotations', 'arrow', 'csv_content', 'csv_file', 'csv_metric_values', 'datapoints_outside_range', 'exponential_heatmap_bucket_data', 'flame_graph', 'grafana_api', 'linear_heatmap_bucket_data', 'live', 'logs', 'manual_entry', 'no_data_points', 'node_graph', 'predictable_csv_wave', 'predictable_pulse', 'random_walk', 'random_walk_table', 'random_walk_with_error', 'raw_frame', 'server_error_500', 'simulation', 'slow_query', 'streaming_client', 'table_static', 'trace', 'usa', 'variables-query'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"annotations"` \n - `"arrow"` \n - `"csv_content"` \n - `"csv_file"` \n - `"csv_metric_values"` \n - `"datapoints_outside_range"` \n - `"exponential_heatmap_bucket_data"` \n - `"flame_graph"` \n - `"grafana_api"` \n - `"linear_heatmap_bucket_data"` \n - `"live"` \n - `"logs"` \n - `"manual_entry"` \n - `"no_data_points"` \n - `"node_graph"` \n - `"predictable_csv_wave"` \n - `"predictable_pulse"` \n - `"random_walk"` \n - `"random_walk_table"` \n - `"random_walk_with_error"` \n - `"raw_frame"` \n - `"server_error_500"` \n - `"simulation"` \n - `"slow_query"` \n - `"streaming_client"` \n - `"table_static"` \n - `"trace"` \n - `"usa"` \n - `"variables-query"` ' } }, + withScenarioId(value): { + scenarioId: value, + }, + '#withSeriesCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSeriesCount(value): { + seriesCount: value, + }, + '#withSim': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSim(value): { + sim: value, + }, + '#withSimMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withSimMixin(value): { + sim+: value, + }, + sim+: + { + '#withConfig': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfig(value): { + sim+: { + config: value, + }, + }, + '#withConfigMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withConfigMixin(value): { + sim+: { + config+: value, + }, + }, + '#withKey': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKey(value): { + sim+: { + key: value, + }, + }, + '#withKeyMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withKeyMixin(value): { + sim+: { + key+: value, + }, + }, + key+: + { + '#withTick': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withTick(value): { + sim+: { + key+: { + tick: value, + }, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withType(value): { + sim+: { + key+: { + type: value, + }, + }, + }, + '#withUid': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUid(value): { + sim+: { + key+: { + uid: value, + }, + }, + }, + }, + '#withLast': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withLast(value=true): { + sim+: { + last: value, + }, + }, + '#withStream': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withStream(value=true): { + sim+: { + stream: value, + }, + }, + }, + '#withSpanCount': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withSpanCount(value): { + spanCount: value, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + spread: value, + }, + '#withStartValue': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withStartValue(value): { + startValue: value, + }, + '#withStream': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStream(value): { + stream: value, + }, + '#withStreamMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withStreamMixin(value): { + stream+: value, + }, + stream+: + { + '#withBands': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['integer'] }], help: '' } }, + withBands(value): { + stream+: { + bands: value, + }, + }, + '#withNoise': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withNoise(value): { + stream+: { + noise: value, + }, + }, + '#withSpeed': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpeed(value): { + stream+: { + speed: value, + }, + }, + '#withSpread': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['number'] }], help: '' } }, + withSpread(value): { + stream+: { + spread: value, + }, + }, + '#withType': { 'function': { args: [{ default: null, enums: ['fetch', 'logs', 'signal', 'traces'], name: 'value', type: ['string'] }], help: 'Possible enum values:\n - `"fetch"` \n - `"logs"` \n - `"signal"` \n - `"traces"` ' } }, + withType(value): { + stream+: { + type: value, + }, + }, + '#withUrl': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withUrl(value): { + stream+: { + url: value, + }, + }, + }, + '#withStringInput': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'common parameter used by many query types' } }, + withStringInput(value): { + stringInput: value, + }, + '#withTimeRange': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRange(value): { + timeRange: value, + }, + '#withTimeRangeMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly' } }, + withTimeRangeMixin(value): { + timeRange+: value, + }, + timeRange+: + { + '#withFrom': { 'function': { args: [{ default: 'now-6h', enums: null, name: 'value', type: ['string'] }], help: 'From is the start time of the query.' } }, + withFrom(value='now-6h'): { + timeRange+: { + from: value, + }, + }, + '#withTo': { 'function': { args: [{ default: 'now', enums: null, name: 'value', type: ['string'] }], help: 'To is the end time of the query.' } }, + withTo(value='now'): { + timeRange+: { + to: value, + }, + }, + }, + '#withUsa': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsa(value): { + usa: value, + }, + '#withUsaMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withUsaMixin(value): { + usa+: value, + }, + usa+: + { + '#withFields': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFields(value): { + usa+: { + fields: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withFieldsMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withFieldsMixin(value): { + usa+: { + fields+: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withMode': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withMode(value): { + usa+: { + mode: value, + }, + }, + '#withPeriod': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withPeriod(value): { + usa+: { + period: value, + }, + }, + '#withStates': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStates(value): { + usa+: { + states: + (if std.isArray(value) + then value + else [value]), + }, + }, + '#withStatesMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['array'] }], help: '' } }, + withStatesMixin(value): { + usa+: { + states+: + (if std.isArray(value) + then value + else [value]), + }, + }, + }, + '#withWithNil': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: '' } }, + withWithNil(value=true): { + withNil: value, + }, +} ++ (import '../custom/query/testData.libsonnet') diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/role.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/role.libsonnet new file mode 100644 index 0000000..552f5a3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/role.libsonnet @@ -0,0 +1,24 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.role', name: 'role' }, + '#withDescription': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Role description' } }, + withDescription(value): { + description: value, + }, + '#withDisplayName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Optional display' } }, + withDisplayName(value): { + displayName: value, + }, + '#withGroupName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'Name of the team.' } }, + withGroupName(value): { + groupName: value, + }, + '#withHidden': { 'function': { args: [{ default: true, enums: null, name: 'value', type: ['boolean'] }], help: 'Do not show this role' } }, + withHidden(value=true): { + hidden: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The role identifier `managed:builtins:editor:permissions`' } }, + withName(value): { + name: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/rolebinding.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/rolebinding.libsonnet new file mode 100644 index 0000000..a0aab6c --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/rolebinding.libsonnet @@ -0,0 +1,92 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.rolebinding', name: 'rolebinding' }, + '#withRole': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRole(value): { + role: value, + }, + '#withRoleMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object', 'object'] }], help: 'The role we are discussing' } }, + withRoleMixin(value): { + role+: value, + }, + role+: + { + '#withBuiltinRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRef(value): { + role+: { + BuiltinRoleRef: value, + }, + }, + '#withBuiltinRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withBuiltinRoleRefMixin(value): { + role+: { + BuiltinRoleRef+: value, + }, + }, + BuiltinRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'BuiltinRole', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: ['viewer', 'editor', 'admin'], name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + '#withCustomRoleRef': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRef(value): { + role+: { + CustomRoleRef: value, + }, + }, + '#withCustomRoleRefMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: '' } }, + withCustomRoleRefMixin(value): { + role+: { + CustomRoleRef+: value, + }, + }, + CustomRoleRef+: + { + '#withKind': { 'function': { args: [], help: '' } }, + withKind(): { + role+: { + kind: 'Role', + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + role+: { + name: value, + }, + }, + }, + }, + '#withSubject': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The team or user that has the specified role' } }, + withSubject(value): { + subject: value, + }, + '#withSubjectMixin': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['object'] }], help: 'The team or user that has the specified role' } }, + withSubjectMixin(value): { + subject+: value, + }, + subject+: + { + '#withKind': { 'function': { args: [{ default: null, enums: ['Team', 'User'], name: 'value', type: ['string'] }], help: '' } }, + withKind(value): { + subject+: { + kind: value, + }, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: 'The team/user identifier name' } }, + withName(value): { + subject+: { + name: value, + }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/team.libsonnet b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/team.libsonnet new file mode 100644 index 0000000..561194d --- /dev/null +++ b/mixin/vendor/github.com/grafana/grafonnet/gen/grafonnet-v11.4.0/team.libsonnet @@ -0,0 +1,12 @@ +// This file is generated, do not manually edit. +{ + '#': { help: 'grafonnet.team', name: 'team' }, + '#withEmail': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withEmail(value): { + email: value, + }, + '#withName': { 'function': { args: [{ default: null, enums: null, name: 'value', type: ['string'] }], help: '' } }, + withName(value): { + name: value, + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CHANGELOG.md b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CHANGELOG.md new file mode 100644 index 0000000..d1192bb --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CHANGELOG.md @@ -0,0 +1,55 @@ +# 0.4.3 +- [Signal] fix: No longer aggregates histogram signals after histogram_quantile() as it is pointless aggregation. Aggregation before applying histogram_quantile() is kept and works as expected. + +# 0.4.2 +- [Panels] Add table rows styles in requests panels. + +# 0.4.1 +- [Utils] Add optional separator='/' attribute to labelsToPanelLegend. +- +# 0.4.0 +- [Signal] Add defaultSignalSource param to set default signal source. + +# 0.3.5 +- [Variables] Add queriesSelectorGroupOnly, queriesSelectorFilterOnly attributes +- [Signal] Add %(queriesSelectorGroupOnly)s, %(queriesSequeriesSelectorFilterOnly)s templates +- [Signal] Fix legend rendering when aggLevel is none +- [Panel] Fix id conflict if topkPercentage panel is used with signal.asTarget() + +# 0.3.4 +- [Signal] Fix interval template for increase/delta functions. + +# 0.3.3 +- [Signal] Add `withQuantile(quantile=0.95)` to histogram signals. + +# 0.3.2 +- [Signal] Fix combining info metrics. + +# 0.3.1 +- [Signal] Fix optional signals (type=stub). +- [Signal] Add optional signals documentation. + +# 0.3.0 + +- [Signal] Add new signal `log`. +- [Signal] Add enableLokiLogs=true|false to signals init. +- [Signal] `withExprWrappersMixin(offset)` - wrap signal expression into additional function on top of existing wrappers. + +# 0.2.0 + +- [Signal] `withOffset(offset)` - add offset modifier to the expression. +- [Signal] `withFilteringSelectorMixin(mixin)` - add additional selector to filteringSelector used. + +# 0.1.0 + +- [Variables] Add support for optional ad hoc variabels +- [Signal] Add support for info metrics in asTableColumn(format='table), now properly showing info metric as one more column +- [Signal] asTable() update: Order and rename Instance/Group labes as first columns in table +- [Signal] Add new attribute "nameShort". if defined this optional alias is used in legends and table column names. +- [Signal] Introduce new class of functions called "modifiers" and first member .withTopK(limit). They don't render signal immediately, instead, they modify the signal. Can be used in builder patterns before finally rendering final panel. Very useful when signals should be rendered a little bit different on different dashboards: +i..e +on fleet dashboard: +`signal.withTopK(25).asTimeSeries()` +on signle host dashboard: +`signal.asTimeSeries()` +- [Signals] fix: group aggregations are now properly applied to info type metrics as well. diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CONTRIB.md b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CONTRIB.md new file mode 100644 index 0000000..fb85608 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/CONTRIB.md @@ -0,0 +1,20 @@ + +## Panels overview + +All panels in this lib should implement one of the following methods: + +- `panel.new(title,targets,description)` - creates new panel. List of arguments could vary; +- `panel.stylize(allLayers=true)` - directly applies this panel style to existing panel. By default includes all layers of styles. To apply only top layer, set allLayers=false. This mode is useful to cherry-pick style layers to create new style combination. + +Some other methods could be found such as: +- `panel.stylizeByRegexp(regexp)` - attaches style as panel overrides (by regexp); +- `panel.stylizeByName(name)` - attaches style as panel overrides (by name). + +## Panels common groups + +This library consists of multiple common groups of panels for widely used resources such as CPU, memory, disks and so on. + +All of those groups inherit `generic` group as their base. + +All panels inherit `generic/base.libsonnet` via `generic//base.libsonnet`. + diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/Makefile b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/Makefile new file mode 100644 index 0000000..0e0d337 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/Makefile @@ -0,0 +1,34 @@ +JSONNET_FMT := jsonnetfmt -n 2 --max-blank-lines 1 --string-style s --comment-style s + +.PHONY: all +all: build + +vendor: jsonnetfile.json + jb install + +.PHONY: build +build: vendor + +.PHONY: fmt +fmt: + find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \ + xargs -n 1 -- $(JSONNET_FMT) -i + +.PHONY: lint +lint: build + find . -name 'vendor' -prune -o -name '*.libsonnet' -print -o -name '*.jsonnet' -print | \ + while read f; do \ + $(JSONNET_FMT) "$$f" | diff -u "$$f" -; \ + done + +.PHONY: tests +tests: build + @RESULT=0; \ + for m in $$(find . -name 'test_*.libsonnet' -print); do \ + echo "Testing $$m"; \ + jsonnet -J vendor "$$m"; \ + if [ $$? -ne 0 ]; then \ + RESULT=1; \ + fi; \ + done; \ + exit $$RESULT \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/README.md b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/README.md new file mode 100644 index 0000000..3f81da6 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/README.md @@ -0,0 +1,39 @@ +# Grafana integrations common lib + +This common library can be used to quickly create dashboards' `panels` and `annotations`. + +By using this common library we can 'enforce' common style choices across multiple dashboards and mixins. + +This library should be considered experimental. + +## Import + +```sh +jb init +jb install https://github.com/grafana/jsonnet-libs/common-lib +``` + +## Use + +### Create new panel + +```jsonnet + +local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet'; +local cpuUsage = commonlib.panels.cpu.timeSeries.utilization.new(targets=[targets.cpuUsage]); + +``` + +### Mutate exisiting panel with style options + +```jsonnet + +local commonlib = import 'github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet'; +local cpuPanel = oldPanel + commonlib.panels.cpu.timeSeries.utilization.stylize(); +``` + +See [windows-observ-lib](../windows-observ-lib/README.md) for implementation example. + +### Signals + +Signals [README](./common/signal/README.md) here. diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/base.libsonnet new file mode 100644 index 0000000..2f592fa --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/base.libsonnet @@ -0,0 +1,31 @@ +local g = import '../g.libsonnet'; +local annotation = g.dashboard.annotation; +{ + new( + title, + target, + ): + annotation.withEnable(true) + + annotation.withName(title) + + annotation.withDatasourceMixin(target.datasource) + { + titleFormat: title, + expr: target.expr, + + } + + (if std.objectHas(target, 'interval') then { step: target.interval } else {}), + + withTagKeys(value): + { + tagKeys: value, + }, + withValueForTime(value=false): + { + useValueForTime: value, + }, + withTextFormat(value=''): + { + textFormat: value, + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/fatal.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/fatal.libsonnet new file mode 100644 index 0000000..409d62d --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/fatal.libsonnet @@ -0,0 +1,14 @@ +local g = import '../g.libsonnet'; +local annotation = g.dashboard.annotation; +local base = import './base.libsonnet'; + +// Show fatal or critical events as annotations +base { + new( + title, + target, + ): + super.new(title, target) + + annotation.withIconColor('light-purple') + + annotation.withHide(true), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/main.libsonnet new file mode 100644 index 0000000..a904f9f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/main.libsonnet @@ -0,0 +1,6 @@ +{ + base: import './base.libsonnet', + reboot: import './reboot.libsonnet', + serviceFailed: import './service_failed.libsonnet', + fatal: import './fatal.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/reboot.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/reboot.libsonnet new file mode 100644 index 0000000..a6d67e1 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/reboot.libsonnet @@ -0,0 +1,16 @@ +local g = import '../g.libsonnet'; +local annotation = g.dashboard.annotation; +local base = import './base.libsonnet'; + +base { + new( + title, + target, + instanceLabels, + ): + super.new(title, target) + + annotation.withIconColor('light-yellow') + + annotation.withHide(true) + + { useValueForTime: 'on' } + + base.withTagKeys(instanceLabels), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/service_failed.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/service_failed.libsonnet new file mode 100644 index 0000000..63f601f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/annotations/service_failed.libsonnet @@ -0,0 +1,13 @@ +local g = import '../g.libsonnet'; +local annotation = g.dashboard.annotation; +local base = import './base.libsonnet'; + +base { + new( + title, + target, + ): + super.new(title, target) + + annotation.withIconColor('light-orange') + + annotation.withHide(true), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/g.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/g.libsonnet new file mode 100644 index 0000000..f89dcc0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/g.libsonnet @@ -0,0 +1 @@ +import 'github.com/grafana/grafonnet/gen/grafonnet-v11.0.0/main.libsonnet' diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet new file mode 100644 index 0000000..2fd023f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/main.libsonnet @@ -0,0 +1,7 @@ +{ + annotations: import './annotations/main.libsonnet', + panels: import './panels.libsonnet', + variables: import './variables/variables.libsonnet', + utils: import './utils.libsonnet', + signals: import './signal/signal.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels.libsonnet new file mode 100644 index 0000000..0ff93ba --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels.libsonnet @@ -0,0 +1,41 @@ +local g = import './g.libsonnet'; + +{ + generic: { + stat: import './panels/generic/stat/main.libsonnet', + timeSeries: import './panels/generic/timeSeries/main.libsonnet', + table: import './panels/generic/table/main.libsonnet', + statusHistory: import './panels/generic/statusHistory/main.libsonnet', + }, + network: { + timeSeries: import './panels/network/timeSeries/main.libsonnet', + statusHistory: import './panels/network/statusHistory/main.libsonnet', + }, + system: { + stat: import './panels/system/stat/main.libsonnet', + table: import './panels/system/table/main.libsonnet', + statusHistory: import './panels/system/statusHistory/main.libsonnet', + timeSeries: import './panels/system/timeSeries/main.libsonnet', + }, + cpu: { + stat: import './panels/cpu/stat/main.libsonnet', + timeSeries: import './panels/cpu/timeSeries/main.libsonnet', + }, + memory: { + stat: import './panels/memory/stat/main.libsonnet', + timeSeries: import './panels/memory/timeSeries/main.libsonnet', + }, + disk: { + timeSeries: import './panels/disk/timeSeries/main.libsonnet', + table: import './panels/disk/table/main.libsonnet', + stat: import './panels/disk/stat/main.libsonnet', + }, + hardware: { + timeSeries: import './panels/hardware/timeSeries/main.libsonnet', + }, + requests: { + timeSeries: import './panels/requests/timeSeries/main.libsonnet', + stat: import './panels/requests/stat/main.libsonnet', + table: import './panels/requests/table/main.libsonnet', + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/base.libsonnet new file mode 100644 index 0000000..587b02b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/base.libsonnet @@ -0,0 +1,7 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../../generic/stat/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/count.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/count.libsonnet new file mode 100644 index 0000000..4b9a9ed --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/count.libsonnet @@ -0,0 +1,22 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; + +base { + new( + title='CPU count', + targets, + description=||| + CPU count is the number of processor cores or central processing units (CPUs) in a computer, + determining its processing capability and ability to handle tasks concurrently. + ||| + ): + super.new(title, targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.info.stylize(allLayers=false) + + g.panel.stat.standardOptions.withUnit('none'), + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/main.libsonnet new file mode 100644 index 0000000..df20b65 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + usage: import './usage.libsonnet', + count: import './count.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/usage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/usage.libsonnet new file mode 100644 index 0000000..bf01915 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/stat/usage.libsonnet @@ -0,0 +1,22 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; + +base { + new( + title='CPU usage', + targets, + description=||| + Total CPU utilization percent is a metric that indicates the overall level of central processing unit (CPU) usage in a computer system. + It represents the combined load placed on all CPU cores or processors. + + For instance, if the total CPU utilization percent is 50%, it means that, + on average, half of the CPU's processing capacity is being used to execute tasks. A higher percentage indicates that the CPU is working more intensively, potentially leading to system slowdowns if it remains consistently high. + ||| + ): + super.new(title, targets, description), + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.percentage.stylize(allLayers=false), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/base.libsonnet new file mode 100644 index 0000000..622d9be --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/base.libsonnet @@ -0,0 +1,6 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/main.libsonnet new file mode 100644 index 0000000..3e90065 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + utilization: import './utilization.libsonnet', + utilizationByMode: import './utilization_by_mode.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization.libsonnet new file mode 100644 index 0000000..fd365ac --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization.libsonnet @@ -0,0 +1,22 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='CPU usage', + targets, + description=||| + Total CPU utilization percent is a metric that indicates the overall level of central processing unit (CPU) usage in a computer system. + It represents the combined load placed on all CPU cores or processors. + + For instance, if the total CPU utilization percent is 50%, it means that, + on average, half of the CPU's processing capacity is being used to execute tasks. A higher percentage indicates that the CPU is working more intensively, potentially leading to system slowdowns if it remains consistently high. + ||| + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.percentage.stylize(allLayers=false), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_core.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_core.libsonnet new file mode 100644 index 0000000..18b0e90 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_core.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='CPU usage', + targets, + description=||| + CPU utilization percent by core is a metric that indicates level of central processing unit (CPU) usage in a computer system. + It represents the load placed on each CPU core or processors. + ||| + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.percentage.stylize(allLayers=false) + + g.panel.timeSeries.fieldConfig.defaults.custom.withStacking({ mode: 'normal' }), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_mode.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_mode.libsonnet new file mode 100644 index 0000000..0377fa4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/cpu/timeSeries/utilization_by_mode.libsonnet @@ -0,0 +1,47 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='CPU usage by modes', + targets, + description='CPU usage by different modes.' + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + local timeSeries = g.panel.timeSeries; + local fieldOverride = g.panel.timeSeries.fieldOverride; + + (if allLayers then super.stylize() else {}) + + + timeSeries.standardOptions.withUnit('percent') + + timeSeries.fieldConfig.defaults.custom.withFillOpacity(80) + + timeSeries.standardOptions.withMax(100) + + timeSeries.standardOptions.withMin(0) + + timeSeries.fieldConfig.defaults.custom.withStacking({ mode: 'normal' }) + + timeSeries.standardOptions.withOverrides( + [ + fieldOverride.byName.new('idle') + + fieldOverride.byName.withPropertiesFromOptions( + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-blue'), + ), + fieldOverride.byName.new('interrupt') + + fieldOverride.byName.withPropertiesFromOptions( + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-purple'), + ), + fieldOverride.byName.new('user') + + fieldOverride.byName.withPropertiesFromOptions( + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-orange'), + ), + fieldOverride.byRegexp.new('system|privileged') + + fieldOverride.byRegexp.withPropertiesFromOptions( + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-red'), + ), + ] + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/base.libsonnet new file mode 100644 index 0000000..09aef26 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/base.libsonnet @@ -0,0 +1,6 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../../generic/stat/base.libsonnet'; + +base { +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/main.libsonnet new file mode 100644 index 0000000..79f3443 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/main.libsonnet @@ -0,0 +1,4 @@ +{ + base: import './base.libsonnet', + total: import './total.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/total.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/total.libsonnet new file mode 100644 index 0000000..6e81dfc --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/stat/total.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; + +base { + new( + title, + targets, + description='' + ): + super.new(title=title, targets=targets, description=description), + + stylize(allLayers=true): + + (if allLayers then super.stylize() else {}) + + + generic.info.stylize(allLayers=false) + + stat.standardOptions.withUnit('bytes'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/base.libsonnet new file mode 100644 index 0000000..6caa7f9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/base.libsonnet @@ -0,0 +1,10 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/table/base.libsonnet'; +local table = g.panel.table; +local fieldOverride = g.panel.table.fieldOverride; +local custom = table.fieldConfig.defaults.custom; +local defaults = table.fieldConfig.defaults; +local options = table.options; +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/main.libsonnet new file mode 100644 index 0000000..5493c27 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/main.libsonnet @@ -0,0 +1,4 @@ +{ + base: import './base.libsonnet', + usage: import './usage.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/usage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/usage.libsonnet new file mode 100644 index 0000000..c86b7d4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/table/usage.libsonnet @@ -0,0 +1,262 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local table = g.panel.table; +local fieldOverride = g.panel.table.fieldOverride; +local custom = table.fieldConfig.defaults.custom; +local defaults = table.fieldConfig.defaults; +local options = table.options; + +base { + new( + title='Disk space usage', + totalTarget, + usageTarget=null, + freeTarget=null, + groupLabel, + description=||| + This table provides information about total disk space, used space, available space, and usage percentages for each mounted file system on the system. + |||, + ): + // validate inputs + std.prune( + { + checks: [ + if (usageTarget == null && freeTarget == null) then error 'Must provide at least one of "usageTarget" or "freeTraget"', + if !(std.objectHas(totalTarget, 'format') && std.assertEqual(totalTarget.format, 'table')) then error 'totalTarget format must be "table"', + if !(std.objectHas(totalTarget, 'instant') && std.assertEqual(totalTarget.instant, true)) then error 'totalTarget must have type "instant"', + if usageTarget != null && !(std.objectHas(usageTarget, 'format') && std.assertEqual(usageTarget.format, 'table')) then error 'usageTarget format must be "table"', + if usageTarget != null && !(std.objectHas(usageTarget, 'instant') && std.assertEqual(usageTarget.instant, true)) then error 'usageTarget must have type "instant"', + if freeTarget != null && !(std.objectHas(freeTarget, 'format') && std.assertEqual(freeTarget.format, 'table')) then error 'freeTarget format must be "table"', + if freeTarget != null && !(std.objectHas(freeTarget, 'instant') && std.assertEqual(freeTarget.instant, true)) then error 'freeTarget must have type "instant"', + ], + } + ) + + if usageTarget != null + then + ( + super.new( + title=title, + targets=[ + totalTarget { refId: 'TOTAL' }, + usageTarget { refId: 'USAGE' }, + ], + description=description, + ) + + $.withUsageTableCommonMixin() + + table.queryOptions.withTransformationsMixin( + [ + { + id: 'groupBy', + options: { + fields: { + 'Value #TOTAL': { + aggregations: [ + 'lastNotNull', + ], + operation: 'aggregate', + }, + 'Value #USAGE': { + aggregations: [ + 'lastNotNull', + ], + operation: 'aggregate', + }, + [groupLabel]: { + aggregations: [], + operation: 'groupby', + }, + }, + }, + }, + { + id: 'merge', + options: {}, + }, + { + id: 'calculateField', + options: { + alias: 'Available', + binary: { + left: 'Value #TOTAL (lastNotNull)', + operator: '-', + reducer: 'sum', + right: 'Value #USAGE (lastNotNull)', + }, + mode: 'binary', + reduce: { + reducer: 'sum', + }, + }, + }, + { + id: 'calculateField', + options: { + alias: 'Used, %', + binary: { + left: 'Value #USAGE (lastNotNull)', + operator: '/', + reducer: 'sum', + right: 'Value #TOTAL (lastNotNull)', + }, + mode: 'binary', + reduce: { + reducer: 'sum', + }, + }, + }, + { + id: 'organize', + options: { + excludeByName: {}, + indexByName: { + [groupLabel]: 0, + 'Value #TOTAL (lastNotNull)': 1, + Available: 2, + 'Value #USAGE (lastNotNull)': 3, + 'Used, %': 4, + }, + renameByName: { + 'Value #TOTAL (lastNotNull)': 'Size', + 'Value #USAGE (lastNotNull)': 'Used', + [groupLabel]: 'Mounted on', + }, + }, + }, + self.transformations.sortBy('Mounted on'), + ] + ) + ) + else if freeTarget != null && usageTarget == null + then + ( + super.new( + title=title, + targets=[ + totalTarget { refId: 'TOTAL' }, + freeTarget { refId: 'FREE' }, + ], + description=description, + ) + + $.withUsageTableCommonMixin() + + table.queryOptions.withTransformationsMixin( + [ + { + id: 'groupBy', + options: { + fields: { + 'Value #TOTAL': { + aggregations: [ + 'lastNotNull', + ], + operation: 'aggregate', + }, + 'Value #FREE': { + aggregations: [ + 'lastNotNull', + ], + operation: 'aggregate', + }, + [groupLabel]: { + aggregations: [], + operation: 'groupby', + }, + }, + }, + }, + { + id: 'merge', + options: {}, + }, + { + id: 'calculateField', + options: { + alias: 'Used', + binary: { + left: 'Value #TOTAL (lastNotNull)', + operator: '-', + reducer: 'sum', + right: 'Value #FREE (lastNotNull)', + }, + mode: 'binary', + reduce: { + reducer: 'sum', + }, + }, + }, + { + id: 'calculateField', + options: { + alias: 'Used, %', + binary: { + left: 'Used', + operator: '/', + reducer: 'sum', + right: 'Value #TOTAL (lastNotNull)', + }, + mode: 'binary', + reduce: { + reducer: 'sum', + }, + }, + }, + { + id: 'organize', + options: { + excludeByName: {}, + indexByName: { + [groupLabel]: 0, + 'Value #TOTAL (lastNotNull)': 1, + 'Value #FREE (lastNotNull)': 2, + Used: 3, + 'Used, %': 4, + }, + renameByName: { + 'Value #TOTAL (lastNotNull)': 'Size', + 'Value #FREE (lastNotNull)': 'Available', + [groupLabel]: 'Mounted on', + }, + }, + }, + self.transformations.sortBy('Mounted on'), + ] + ) + ) + else {}, + + withUsageTableCommonMixin(): + table.standardOptions.thresholds.withSteps( + [ + table.thresholdStep.withColor('light-blue') + + table.thresholdStep.withValue(null), + table.thresholdStep.withColor('light-yellow') + + table.thresholdStep.withValue(0.8), + table.thresholdStep.withColor('light-red') + + table.thresholdStep.withValue(0.9), + ] + ) + + + table.standardOptions.withOverrides([ + fieldOverride.byName.new('Mounted on') + + fieldOverride.byName.withProperty('custom.width', 260), + fieldOverride.byName.new('Size') + + fieldOverride.byName.withProperty('custom.width', 80), + fieldOverride.byName.new('Used') + + fieldOverride.byName.withProperty('custom.width', 80), + fieldOverride.byName.new('Available') + + fieldOverride.byName.withProperty('custom.width', 80), + fieldOverride.byName.new('Used, %') + + fieldOverride.byName.withProperty( + 'custom.cellOptions', { + type: 'gauge', + mode: 'basic', + valueDisplayMode: 'text', + } + ) + + fieldOverride.byName.withPropertiesFromOptions( + table.standardOptions.withMax(1) + + table.standardOptions.withMin(0) + + table.standardOptions.withUnit('percentunit') + ), + ]) + + table.standardOptions.withUnit('bytes'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/available.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/available.libsonnet new file mode 100644 index 0000000..0e707c0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/available.libsonnet @@ -0,0 +1,23 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk space available', + targets, + description='', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + + timeSeries.standardOptions.withUnit('bytes') + + timeSeries.standardOptions.withMin(0), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/base.libsonnet new file mode 100644 index 0000000..060fa12 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/base.libsonnet @@ -0,0 +1,26 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + // Decrease opacity (would look better with too many timeseries) + + defaults.custom.withFillOpacity(1), + + withNegateOutPackets(regexp='/write|written/'): + defaults.custom.withAxisLabel('write(-) | read(+)') + + defaults.custom.withAxisCenteredZero(true) + + timeSeries.standardOptions.withOverrides( + fieldOverride.byRegexp.new(regexp) + + fieldOverride.byRegexp.withPropertiesFromOptions( + defaults.custom.withTransform('negative-Y') + ) + ), + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_bytes_persec.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_bytes_persec.libsonnet new file mode 100644 index 0000000..addf4f4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_bytes_persec.libsonnet @@ -0,0 +1,31 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk reads/writes', + targets, + description='Disk read/writes in bytes per second.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + + timeSeries.standardOptions.withUnit('Bps') + // move 'IO busy time' to second axis if found + + timeSeries.standardOptions.withOverrides( + fieldOverride.byRegexp.new('/time|used|busy|util/') + + fieldOverride.byRegexp.withPropertiesFromOptions( + timeSeries.standardOptions.withUnit('percent') + + timeSeries.fieldConfig.defaults.custom.withDrawStyle('points') + + timeSeries.fieldConfig.defaults.custom.withAxisSoftMax(100) + ) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_queue.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_queue.libsonnet new file mode 100644 index 0000000..157796a --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_queue.libsonnet @@ -0,0 +1,23 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk IO queue', + targets, + description='Disk average IO queue.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + + self.withNegateOutPackets(), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_wait_time.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_wait_time.libsonnet new file mode 100644 index 0000000..ae17d52 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/io_wait_time.libsonnet @@ -0,0 +1,25 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk average wait time', + targets, + description=||| + The average time for requests issued to the device to be served. + This includes the time spent by the requests in queue and the time spent servicing them.' + ||| + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('s') + + self.withNegateOutPackets(), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/iops.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/iops.libsonnet new file mode 100644 index 0000000..fd30b05 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/iops.libsonnet @@ -0,0 +1,23 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk I/O', + targets, + description=||| + The number of I/O requests per second for the device/volume. + ||| + ): + super.new(title, targets, description) + + self.stylize(), + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('iops') + + self.withNegateOutPackets(), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/main.libsonnet new file mode 100644 index 0000000..5fc8df5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/main.libsonnet @@ -0,0 +1,10 @@ +{ + base: import './base.libsonnet', + ioBytesPerSec: import './io_bytes_persec.libsonnet', + iops: import './iops.libsonnet', + ioQueue: import './io_queue.libsonnet', + ioWaitTime: import './io_wait_time.libsonnet', + available: import './available.libsonnet', + usage: import './usage.libsonnet', + usagePercent: import './usage_percent.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage.libsonnet new file mode 100644 index 0000000..84b2fab --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage.libsonnet @@ -0,0 +1,23 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk space used', + targets, + description=||| + Disk space usage is the amount of storage being used on a device's hard drive or storage medium, in bytes. + |||, + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('bytes'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage_percent.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage_percent.libsonnet new file mode 100644 index 0000000..f5d3554 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/disk/timeSeries/usage_percent.libsonnet @@ -0,0 +1,25 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Disk space used, %', + targets, + description=||| + Disk space usage is the amount of storage being used on a device's hard drive or storage medium, in percent. + |||, + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('percent') + + generic.percentage.stylize(allLayers=false), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/base.libsonnet new file mode 100644 index 0000000..067cf53 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/base.libsonnet @@ -0,0 +1,27 @@ +local g = import '../../g.libsonnet'; + +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; + +// This is base of ALL panels in the common lib +{ + new(targets, description=''): + // hidden field to hold styles modifiers + + timeSeries.queryOptions.withTargets(targets) + + timeSeries.panelOptions.withDescription(description) + // set first target's datasource + // to panel's datasource if only single type of + // datasoures are used accross all targets: + + (if std.length(std.set(targets, function(t) t.datasource.type)) == 1 then + timeSeries.queryOptions.withDatasource( + targets[0].datasource.type, targets[0].datasource.uid + ) else {}) + + self.stylize(), + + stylize(): {}, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/base.libsonnet new file mode 100644 index 0000000..bcfbf9c --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/base.libsonnet @@ -0,0 +1,14 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../base.libsonnet'; + +base { + new(title, targets, description=''): + stat.new(title) + + super.new(targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.color.withMode('fixed') + + stat.standardOptions.color.withFixedColor('text'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/info.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/info.libsonnet new file mode 100644 index 0000000..05fc5a7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/info.libsonnet @@ -0,0 +1,21 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; +// Simple info panel prototype with text or count of things. +base { + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + // Style choice: No color for simple text panels by default + + stat.options.withColorMode('fixed') + + stat.standardOptions.color.withFixedColor('text') + // Style choice: No graph + + stat.options.withGraphMode('none') + // Show last value by default, not mean. + + stat.options.withReduceOptions({}) + + stat.options.reduceOptions.withCalcsMixin( + [ + 'lastNotNull', + ] + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/main.libsonnet new file mode 100644 index 0000000..93899e7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + info: import './info.libsonnet', + percentage: import './percentage.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/percentage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/percentage.libsonnet new file mode 100644 index 0000000..a8a8d90 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/stat/percentage.libsonnet @@ -0,0 +1,24 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import './base.libsonnet'; +// This panel can be used to display gauge metrics with possible values range 0-100%. +// Examples: cpu utilization, memory utilization etc. +base { + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.withDecimals(1) + + stat.standardOptions.withUnit('percent') + + stat.options.withColorMode('value') + // Change color from blue(cold) to red(hot) + + stat.standardOptions.color.withMode('continuous-BlYlRd') + + stat.standardOptions.withMax(100) + + stat.standardOptions.withMin(0) + // Show last value by default, not mean. + + stat.options.withReduceOptions({}) + + stat.options.reduceOptions.withCalcsMixin( + [ + 'lastNotNull', + ] + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/base.libsonnet new file mode 100644 index 0000000..bbc7b02 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/base.libsonnet @@ -0,0 +1,18 @@ +local g = import '../../../g.libsonnet'; +local base = import '../base.libsonnet'; +local statusHistory = g.panel.statusHistory; +local fieldOverride = g.panel.statusHistory.fieldOverride; +local custom = statusHistory.fieldConfig.defaults.custom; +local defaults = statusHistory.fieldConfig.defaults; +local options = statusHistory.options; +base { + + new(title, targets, description=''): + statusHistory.new(title) + + super.new(targets, description) + // Minimize number of points to avoid 'Too many data points' error on large time intervals + + statusHistory.queryOptions.withMaxDataPoints(50), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/main.libsonnet new file mode 100644 index 0000000..3b77b58 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/statusHistory/main.libsonnet @@ -0,0 +1,3 @@ +{ + base: import './base.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/base.libsonnet new file mode 100644 index 0000000..1575b50 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/base.libsonnet @@ -0,0 +1,33 @@ +local g = import '../../../g.libsonnet'; + +local table = g.panel.table; +local fieldOverride = g.panel.table.fieldOverride; +local custom = table.fieldConfig.defaults.custom; +local defaults = table.fieldConfig.defaults; +local options = table.options; +local base = import '../base.libsonnet'; + +base { + new(title, targets, description=''): + table.new(title) + + super.new(targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}), + + transformations+: { + sortBy(field, desc=false): + { + id: 'sortBy', + options: { + fields: {}, + sort: [ + { + field: field, + desc: desc, + }, + ], + }, + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/cold_hot_gauge.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/cold_hot_gauge.libsonnet new file mode 100644 index 0000000..ada99c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/cold_hot_gauge.libsonnet @@ -0,0 +1,25 @@ +local g = import '../../../g.libsonnet'; +local table = g.panel.table; +local timeSeries = g.panel.timeSeries; +local percentage = import '../timeSeries/percentage.libsonnet'; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local fieldConfig = g.panel.timeSeries.fieldConfig; +local base = import './base.libsonnet'; +// This panel can be used to display gauge metrics in table columns with unknown max/min values. +// Examples: Network bandwidth, RPS. +base { + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name' + stylizeByName(name): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'gauge', mode: 'basic' }) + + fieldOverride.byName.withProperty('fieldMinMax', true) + + fieldOverride.byName.withPropertiesFromOptions( + timeSeries.standardOptions.color.withMode('continuous-BlYlRd') + ), + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/main.libsonnet new file mode 100644 index 0000000..eda5e43 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + coldHotGauge: import './cold_hot_gauge.libsonnet', + percentage: import './percentage.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/percentage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/percentage.libsonnet new file mode 100644 index 0000000..30a727a --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/table/percentage.libsonnet @@ -0,0 +1,21 @@ +local g = import '../../../g.libsonnet'; +local table = g.panel.table; +local percentage = import '../timeSeries/percentage.libsonnet'; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local fieldConfig = g.panel.timeSeries.fieldConfig; +local base = import './base.libsonnet'; +// This panel can be used to display gauge table columns with values from 0 to 100%. +// Examples: CPU utilization, memory utilization etc. +base { + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name' + stylizeByName(name): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'gauge', mode: 'basic' }) + + fieldOverride.byName.withPropertiesFromOptions(percentage.stylize(allLayers=false)), + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/base.libsonnet new file mode 100644 index 0000000..da5adb8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/base.libsonnet @@ -0,0 +1,42 @@ +local g = import '../../../g.libsonnet'; + +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +local standardOptions = g.panel.timeSeries.standardOptions; +local base = import '../base.libsonnet'; +base { + new(title, targets, description=''): + timeSeries.new(title) + + super.new(targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + // Style choice: Make lines more thick + + custom.withLineWidth(2) + // Style choice: Opacity level + + custom.withFillOpacity(30) + // Style choice: Don't show points on lines + + custom.withShowPoints('never') + // Style choice: Opacity gradient + + custom.withGradientMode('opacity') + // Style choice: Smoother lines + + custom.withLineInterpolation('smooth') + // Style choice: Show all values in tooltip, sorted + + options.tooltip.withMode('multi') + + options.tooltip.withSort('desc') + // Style choice: Use simple legend without any values (cleaner look) + + options.legend.withDisplayMode('list') + + options.legend.withCalcs([]), + + withDataLink(instanceLabels, drillDownDashboardUid): + standardOptions.withLinks( + { + url: '/d/' + drillDownDashboardUid + '?' + std.join('&', std.map(function(l) 'var-%s=${__field.labels.%s}' % [l, l], instanceLabels)) + '&${__url_time_range}&${datasource:queryparam}', + title: 'Drill down to this instance', + } + ), + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/main.libsonnet new file mode 100644 index 0000000..9280448 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/main.libsonnet @@ -0,0 +1,6 @@ +{ + base: import './base.libsonnet', + percentage: import './percentage.libsonnet', + threshold: import './threshold.libsonnet', + topkPercentage: import './topk_percentage.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/percentage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/percentage.libsonnet new file mode 100644 index 0000000..3a538be --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/percentage.libsonnet @@ -0,0 +1,16 @@ +local g = import '../../../g.libsonnet'; +local timeSeries = g.panel.timeSeries; +local base = import './base.libsonnet'; +// This panel can be used to display gauge metrics with possible values range 0-100%. +// Examples: cpu utilization, memory utilization etc. +base { + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + timeSeries.standardOptions.withDecimals(1) + + timeSeries.standardOptions.withUnit('percent') + // Change color from blue(cold) to red(hot) + + timeSeries.standardOptions.color.withMode('continuous-BlYlRd') + + timeSeries.fieldConfig.defaults.custom.withGradientMode('scheme') + + timeSeries.standardOptions.withMax(100) + + timeSeries.standardOptions.withMin(0), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/threshold.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/threshold.libsonnet new file mode 100644 index 0000000..b338495 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/threshold.libsonnet @@ -0,0 +1,25 @@ +local g = import '../../../g.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local fieldConfig = g.panel.timeSeries.fieldConfig; + +// Turns any series to threshold line: dashed red line without gradient fill +{ + local this = self, + + stylize(): + fieldConfig.defaults.custom.withLineStyleMixin( + { + fill: 'dash', + dash: [10, 10], + } + ) + + fieldConfig.defaults.custom.withFillOpacity(0) + + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-orange'), + stylizeByRegexp(regexp): + timeSeries.standardOptions.withOverridesMixin( + fieldOverride.byRegexp.new(regexp) + + fieldOverride.byRegexp.withPropertiesFromOptions(this.stylize()) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/topk_percentage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/topk_percentage.libsonnet new file mode 100644 index 0000000..6b35e02 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/generic/timeSeries/topk_percentage.libsonnet @@ -0,0 +1,58 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local generic = import './main.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local fieldConfig = g.panel.timeSeries.fieldConfig; +local standardOptions = g.panel.timeSeries.standardOptions; +// Style to display Top K metrics that can go from 0 to 100%. +// It constructs mean baseline automatically. +base { + new( + title, + target, + topk=25, + instanceLabels, + drillDownDashboardUid, + description='Top %s' % topk + ): + + local topTarget = target + { expr: 'topk(' + topk + ',' + target.expr + ')' } + + g.query.prometheus.withLegendFormat( + std.join(': ', std.map(function(l) '{{' + l + '}}', instanceLabels)) + ); + local meanTarget = target + { expr: 'avg(' + target.expr + ')' } + + g.query.prometheus.withLegendFormat('Mean') + + g.query.prometheus.withRefId('Mean'); + super.new(title, targets=[topTarget, meanTarget], description=description) + + self.withDataLink(instanceLabels, drillDownDashboardUid), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.percentage.stylize(allLayers=false) + + fieldConfig.defaults.custom.withFillOpacity(1) + + fieldConfig.defaults.custom.withLineWidth(1) + + timeSeries.options.legend.withDisplayMode('table') + + timeSeries.options.legend.withPlacement('right') + + timeSeries.options.legend.withCalcsMixin([ + 'mean', + 'max', + 'lastNotNull', + ]) + + timeSeries.standardOptions.withOverrides( + fieldOverride.byName.new('Mean') + + fieldOverride.byName.withPropertiesFromOptions( + fieldConfig.defaults.custom.withLineStyleMixin( + { + fill: 'dash', + dash: [10, 10], + } + ) + + fieldConfig.defaults.custom.withFillOpacity(0) + + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-purple'), + ) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/base.libsonnet new file mode 100644 index 0000000..622d9be --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/base.libsonnet @@ -0,0 +1,6 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/main.libsonnet new file mode 100644 index 0000000..a15cc86 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/main.libsonnet @@ -0,0 +1,4 @@ +{ + base: import './base.libsonnet', + temperature: import './temperature.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/temperature.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/temperature.libsonnet new file mode 100644 index 0000000..dbc971e --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/hardware/timeSeries/temperature.libsonnet @@ -0,0 +1,25 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +base { + new( + title='Temperature', + targets, + description=||| + Temperature sensors values. + ||| + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true, softMin=0, softMax=100, unit='Celsius'): + (if allLayers then super.stylize() else {}) + + timeSeries.fieldConfig.defaults.custom.withAxisSoftMax(softMax) + + timeSeries.fieldConfig.defaults.custom.withAxisSoftMin(softMin) + + timeSeries.standardOptions.withDecimals(1) + + timeSeries.standardOptions.withUnit('celsius') + // Change color from blue(cold) to red(hot) + + timeSeries.standardOptions.color.withMode('continuous-BlYlRd') + + timeSeries.fieldConfig.defaults.custom.withGradientMode('scheme'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/base.libsonnet new file mode 100644 index 0000000..587b02b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/base.libsonnet @@ -0,0 +1,7 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../../generic/stat/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/main.libsonnet new file mode 100644 index 0000000..fe214ee --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + total: import './total.libsonnet', + usage: import './usage.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/total.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/total.libsonnet new file mode 100644 index 0000000..c230e29 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/total.libsonnet @@ -0,0 +1,27 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; +local fieldOverride = g.panel.stat.fieldOverride; +local custom = stat.fieldConfig.defaults.custom; +local defaults = stat.fieldConfig.defaults; +local options = stat.options; +base { + new( + title='Memory total', + targets, + description=||| + Amount of random-access memory (RAM) installed. + It represents the system's available working memory that applications and the operating system use to perform tasks. + A higher memory total generally leads to better system performance and the ability to run more demanding applications and processes simultaneously. + ||| + ): + super.new(title=title, targets=targets, description=description), + + stylize(allLayers=true): + + (if allLayers then super.stylize() else {}) + + + generic.info.stylize(allLayers=false) + + stat.standardOptions.withUnit('bytes'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/usage.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/usage.libsonnet new file mode 100644 index 0000000..26f7fb2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/stat/usage.libsonnet @@ -0,0 +1,24 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; +local fieldOverride = g.panel.stat.fieldOverride; +local custom = stat.fieldConfig.defaults.custom; +local defaults = stat.fieldConfig.defaults; +local options = stat.options; +base { + new( + title='Memory usage', + targets, + description='RAM (random-access memory) currently in use by the operating system and running applications, in percent.' + ): + super.new(title=title, targets=targets, description=description), + + stylize(allLayers=true): + + (if allLayers then super.stylize() else {}) + + + generic.percentage.stylize(allLayers=false) + + stat.standardOptions.withUnit('percent'), + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/base.libsonnet new file mode 100644 index 0000000..dae01c3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/base.libsonnet @@ -0,0 +1,10 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/main.libsonnet new file mode 100644 index 0000000..8a48e36 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/main.libsonnet @@ -0,0 +1,5 @@ +{ + base: import './base.libsonnet', + usagePercent: import './usage_percent.libsonnet', + usageBytes: import './usage_bytes.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_bytes.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_bytes.libsonnet new file mode 100644 index 0000000..623f54b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_bytes.libsonnet @@ -0,0 +1,26 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + totalRegexp:: '.*(T|t)otal.*', + new( + title='Memory usage', + targets, + description=||| + RAM (random-access memory) currently in use by the operating system and running applications, in bytes. + |||, + totalRegexp=self.totalRegexp, + ): + super.new(title=title, targets=targets, description=description), + + stylize(allLayers=true, totalRegexp=self.totalRegexp): + (if allLayers then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('bytes') + + timeSeries.standardOptions.withMin(0) + + generic.threshold.stylizeByRegexp(totalRegexp), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_percent.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_percent.libsonnet new file mode 100644 index 0000000..4f1fa51 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/memory/timeSeries/usage_percent.libsonnet @@ -0,0 +1,22 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Memory usage', + targets, + description=||| + RAM (random-access memory) currently in use by the operating system and running applications, in percent. + ||| + ): + super.new(title=title, targets=targets, description=description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + generic.percentage.stylize(allLayers=false), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/base.libsonnet new file mode 100644 index 0000000..b382399 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/base.libsonnet @@ -0,0 +1,5 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/statusHistory/base.libsonnet'; +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/interface_status.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/interface_status.libsonnet new file mode 100644 index 0000000..78ae916 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/interface_status.libsonnet @@ -0,0 +1,29 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local statusHistory = g.panel.statusHistory; +base { + new(title='Interface status', targets, description='Interfaces statuses'): + super.new(title, targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + statusHistory.standardOptions.color.withMode('fixed') + + statusHistory.options.withShowValue('never') + + statusHistory.standardOptions.withMappings( + { + type: 'value', + options: { + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + }, + } + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/main.libsonnet new file mode 100644 index 0000000..04d1376 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/statusHistory/main.libsonnet @@ -0,0 +1,3 @@ +{ + interfaceStatus: import './interface_status.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/base.libsonnet new file mode 100644 index 0000000..53e5f45 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/base.libsonnet @@ -0,0 +1,27 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + + timeSeries.standardOptions.withDecimals(1) + + timeSeries.standardOptions.withUnit('pps') + + timeSeries.standardOptions.withNoValue('No packets'), + + withNegateOutPackets(regexp='/transmit|tx|out/'): + defaults.custom.withAxisLabel('out(-) | in(+)') + + defaults.custom.withAxisCenteredZero(false) + + timeSeries.standardOptions.withOverrides( + fieldOverride.byRegexp.new(regexp) + + fieldOverride.byRegexp.withPropertiesFromOptions( + defaults.custom.withTransform('negative-Y') + ) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/broadcast.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/broadcast.libsonnet new file mode 100644 index 0000000..fe3efb5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/broadcast.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Broadcast packets', + targets, + description='Packets sent from one source to all network nodes.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withNoValue('No broadcast packets'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/dropped.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/dropped.libsonnet new file mode 100644 index 0000000..22700e9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/dropped.libsonnet @@ -0,0 +1,28 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Dropped packets', + targets, + description=||| + Dropped packets occur when data packets traveling through a network are intentionally discarded or lost due to congestion, resource limitations, or network configuration issues. + + Common causes include network congestion, buffer overflows, QoS settings, and network errors, as corrupted or incomplete packets may be discarded by receiving devices. + + Dropped packets can impact network performance and lead to issues such as degraded voice or video quality in real-time applications. + |||, + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + + timeSeries.standardOptions.withNoValue('No dropped packets'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/errors.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/errors.libsonnet new file mode 100644 index 0000000..eb7b313 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/errors.libsonnet @@ -0,0 +1,26 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Network errors', + targets, + description=||| + Network errors refer to issues that occur during the transmission of data across a network. + + These errors can result from various factors, including physical issues, jitter, collisions, noise and interference. + + Monitoring network errors is essential for diagnosing and resolving issues, as they can indicate problems with network hardware or environmental factors affecting network quality. + |||, + ): + super.new(title, targets, description) + + self.stylize(), + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withNoValue('No errors'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/main.libsonnet new file mode 100644 index 0000000..e2d472a --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/main.libsonnet @@ -0,0 +1,10 @@ +{ + base: import './base.libsonnet', + broadcast: import './broadcast.libsonnet', + traffic: import './traffic.libsonnet', + errors: import './errors.libsonnet', + dropped: import './dropped.libsonnet', + packets: import './packets.libsonnet', + multicast: import './multicast.libsonnet', + unicast: import './unicast.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/multicast.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/multicast.libsonnet new file mode 100644 index 0000000..c6d3470 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/multicast.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Multicast packets', + targets, + description='Packets sent from one source to multiple recipients simultaneously, allowing efficient one-to-many communication in a network.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withNoValue('No multicast packets'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/packets.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/packets.libsonnet new file mode 100644 index 0000000..39e1376 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/packets.libsonnet @@ -0,0 +1,19 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Network packets', + targets, + description='Network packet count tracks the number of data packets transmitted and received over a network connection, providing insight into network activity and performance.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers == true then super.stylize() else {}), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/traffic.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/traffic.libsonnet new file mode 100644 index 0000000..92fa26e --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/traffic.libsonnet @@ -0,0 +1,22 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Network traffic', + targets, + description='Network traffic (bits per sec) measures data transmitted and received.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withUnit('bps') + + timeSeries.standardOptions.withNoValue('No traffic'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/unicast.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/unicast.libsonnet new file mode 100644 index 0000000..d347824 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/network/timeSeries/unicast.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + new( + title='Unicast packets', + targets, + description='Packets sent from one source to a single destination.', + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers == true then super.stylize() else {}) + + timeSeries.standardOptions.withNoValue('No unicast packets'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/base.libsonnet new file mode 100644 index 0000000..587b02b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/base.libsonnet @@ -0,0 +1,7 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../../generic/stat/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/duration.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/duration.libsonnet new file mode 100644 index 0000000..a10f98e --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/duration.libsonnet @@ -0,0 +1,16 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; +base { + new(title='Response time', targets, description='Response time.'): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.color.withMode('fixed') + + stat.standardOptions.color.withFixedColor('light-blue') + + stat.standardOptions.withUnit('s') + + stat.options.withGraphMode('none'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/errors.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/errors.libsonnet new file mode 100644 index 0000000..a7d64d8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/errors.libsonnet @@ -0,0 +1,17 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; + +base { + new(title='Errors', targets, description='Rate of errors.'): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.color.withMode('fixed') + + stat.standardOptions.color.withFixedColor('light-red') + + stat.standardOptions.withNoValue('No errors') + + stat.options.withGraphMode('none'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/main.libsonnet new file mode 100644 index 0000000..841f2bd --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/main.libsonnet @@ -0,0 +1,5 @@ +{ + rate: import './rate.libsonnet', + duration: import './duration.libsonnet', + errors: import './errors.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/rate.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/rate.libsonnet new file mode 100644 index 0000000..f2a8f57 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/stat/rate.libsonnet @@ -0,0 +1,16 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; + +base { + new(title='Rate', targets, description='Rate of requests.'): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.color.withMode('fixed') + + stat.standardOptions.color.withFixedColor('light-purple') + + stat.options.withGraphMode('none'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/base.libsonnet new file mode 100644 index 0000000..c120e15 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/base.libsonnet @@ -0,0 +1,9 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/table/base.libsonnet'; +local table = g.panel.table; +local fieldOverride = g.panel.table.fieldOverride; +local custom = table.fieldConfig.defaults.custom; +local defaults = table.fieldConfig.defaults; +local options = table.options; +base { +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/duration.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/duration.libsonnet new file mode 100644 index 0000000..067e1c4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/duration.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local duration = import '../stat/duration.libsonnet'; +local base = import './base.libsonnet'; +local table = g.panel.table; +local fieldOverride = table.fieldOverride; + +base { + local this = self, + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name="Duration"' + stylizeByName(name='Duration'): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) + + fieldOverride.byName.withPropertiesFromOptions(duration.stylize(allLayers=false),) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/errors.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/errors.libsonnet new file mode 100644 index 0000000..c31beaf --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/errors.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local errors = import '../stat/errors.libsonnet'; +local base = import './base.libsonnet'; +local table = g.panel.table; +local fieldOverride = table.fieldOverride; + +base { + local this = self, + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name="Errors"' + stylizeByName(name='Errors'): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) + + fieldOverride.byName.withPropertiesFromOptions(errors.stylize(allLayers=false),) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/main.libsonnet new file mode 100644 index 0000000..14e5f90 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/main.libsonnet @@ -0,0 +1,6 @@ +{ + base: import './base.libsonnet', + errors: import './errors.libsonnet', + rate: import './rate.libsonnet', + duration: import './duration.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/rate.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/rate.libsonnet new file mode 100644 index 0000000..43ffbe9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/table/rate.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local rate = import '../stat/rate.libsonnet'; +local base = import './base.libsonnet'; +local table = g.panel.table; +local fieldOverride = table.fieldOverride; + +base { + local this = self, + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name="Rate"' + stylizeByName(name='Rate'): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) + + fieldOverride.byName.withPropertiesFromOptions(rate.stylize(allLayers=false),) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/base.libsonnet new file mode 100644 index 0000000..622d9be --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/base.libsonnet @@ -0,0 +1,6 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/duration.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/duration.libsonnet new file mode 100644 index 0000000..1668aad --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/duration.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='Response time', + targets, + description=||| + Response time. + ||| + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + g.panel.timeSeries.standardOptions.color.withMode('fixed') + + g.panel.timeSeries.standardOptions.color.withFixedColor('blue') + + g.panel.timeSeries.standardOptions.withUnit('s'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/errors.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/errors.libsonnet new file mode 100644 index 0000000..cad5dae --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/errors.libsonnet @@ -0,0 +1,24 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='Errors', + targets, + description='Request errors.' + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + local timeSeries = g.panel.timeSeries; + local fieldOverride = g.panel.timeSeries.fieldOverride; + + (if allLayers then super.stylize() else {}) + + timeSeries.fieldConfig.defaults.custom.withDrawStyle('bars') + + timeSeries.queryOptions.withMaxDataPoints(100) + + timeSeries.fieldConfig.defaults.custom.withFillOpacity(100) + + timeSeries.fieldConfig.defaults.custom.withStacking({ mode: 'normal' }) + + timeSeries.standardOptions.color.withMode('fixed') + + timeSeries.standardOptions.color.withFixedColor('light-red') + + timeSeries.standardOptions.withNoValue('No errors'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/main.libsonnet new file mode 100644 index 0000000..c01a5de --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/main.libsonnet @@ -0,0 +1,6 @@ +{ + base: import './base.libsonnet', + rate: import './rate.libsonnet', + errors: import './errors.libsonnet', + duration: import './duration.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/rate.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/rate.libsonnet new file mode 100644 index 0000000..3956d10 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/requests/timeSeries/rate.libsonnet @@ -0,0 +1,24 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +base { + new( + title='Load / $__interval', + targets, + description=||| + Requests rate per $__interval + |||, + + ): + super.new(title, targets, description) + + self.stylize(), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + g.panel.timeSeries.fieldConfig.defaults.custom.withDrawStyle('bars') + + g.panel.timeSeries.queryOptions.withMaxDataPoints(100) + + g.panel.timeSeries.fieldConfig.defaults.custom.withFillOpacity(100) + + g.panel.timeSeries.fieldConfig.defaults.custom.withStacking({ mode: 'normal' }) + + g.panel.timeSeries.standardOptions.color.withMode('fixed') + + g.panel.timeSeries.standardOptions.color.withFixedColor('light-purple'), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/base.libsonnet new file mode 100644 index 0000000..587b02b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/base.libsonnet @@ -0,0 +1,7 @@ +local g = import '../../../g.libsonnet'; +local stat = g.panel.stat; +local base = import '../../generic/stat/base.libsonnet'; + +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/main.libsonnet new file mode 100644 index 0000000..d79009c --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/main.libsonnet @@ -0,0 +1,3 @@ +{ + uptime: import './uptime.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/uptime.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/uptime.libsonnet new file mode 100644 index 0000000..4482826 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/stat/uptime.libsonnet @@ -0,0 +1,34 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/stat/main.libsonnet'; +local base = import './base.libsonnet'; +local stat = g.panel.stat; +// Uptime panel. expects duration in seconds as input +base { + new(title='Uptime', targets, description='The duration of time that has passed since the last reboot or system start.'): + super.new(title, targets, description) + + stat.options.withReduceOptions({}) + + stat.options.reduceOptions.withCalcsMixin( + [ + 'lastNotNull', + ] + ) + + self.stylize(), + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + stat.standardOptions.withDecimals(1) + + stat.standardOptions.withUnit('dtdurations') + + stat.standardOptions.color.withMode('thresholds') + + stat.options.withColorMode('value') + + stat.options.withGraphMode('none') + + stat.standardOptions.thresholds.withMode('absolute') + + stat.standardOptions.thresholds.withSteps( + [ + // Warn with orange color when uptime resets: + stat.thresholdStep.withColor('orange') + + stat.thresholdStep.withValue(null), + // clear color after 10 minutes: + stat.thresholdStep.withColor('text') + + stat.thresholdStep.withValue(600), + ] + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/base.libsonnet new file mode 100644 index 0000000..b382399 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/base.libsonnet @@ -0,0 +1,5 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/statusHistory/base.libsonnet'; +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/main.libsonnet new file mode 100644 index 0000000..0cc0937 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/main.libsonnet @@ -0,0 +1,3 @@ +{ + ntp: import './ntp.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/ntp.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/ntp.libsonnet new file mode 100644 index 0000000..42d1c23 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/statusHistory/ntp.libsonnet @@ -0,0 +1,28 @@ +local g = import '../../../g.libsonnet'; +local base = import './base.libsonnet'; +local statusHistory = g.panel.statusHistory; +base { + new(title='NTP status', targets, description=''): + super.new(title, targets, description), + + stylize(allLayers=true): + (if allLayers then super.stylize() else {}) + + statusHistory.standardOptions.color.withMode('fixed') + + statusHistory.standardOptions.withMappings( + { + type: 'value', + options: { + '0': { + text: 'Not in sync', + color: 'light-yellow', + index: 1, + }, + '1': { + text: 'In sync', + color: 'light-green', + index: 0, + }, + }, + } + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/base.libsonnet new file mode 100644 index 0000000..c120e15 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/base.libsonnet @@ -0,0 +1,9 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/table/base.libsonnet'; +local table = g.panel.table; +local fieldOverride = g.panel.table.fieldOverride; +local custom = table.fieldConfig.defaults.custom; +local defaults = table.fieldConfig.defaults; +local options = table.options; +base { +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/main.libsonnet new file mode 100644 index 0000000..aa2ce04 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/main.libsonnet @@ -0,0 +1,4 @@ +{ + base: import './base.libsonnet', + uptime: import './uptime.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/uptime.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/uptime.libsonnet new file mode 100644 index 0000000..c40dd12 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/table/uptime.libsonnet @@ -0,0 +1,20 @@ +local g = import '../../../g.libsonnet'; +local uptime = import '../stat/uptime.libsonnet'; +local base = import './base.libsonnet'; +local table = g.panel.table; +local fieldOverride = table.fieldOverride; + +base { + local this = self, + + new(): error 'not supported', + stylize(): error 'not supported', + + // when attached to table, this function applies style to row named 'name="Uptime"' + stylizeByName(name='Uptime'): + table.standardOptions.withOverridesMixin( + fieldOverride.byName.new(name) + + fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) + + fieldOverride.byName.withPropertiesFromOptions(uptime.stylize(allLayers=false),) + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/base.libsonnet new file mode 100644 index 0000000..dae01c3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/base.libsonnet @@ -0,0 +1,10 @@ +local g = import '../../../g.libsonnet'; +local base = import '../../generic/timeSeries/base.libsonnet'; +local timeSeries = g.panel.timeSeries; +local fieldOverride = g.panel.timeSeries.fieldOverride; +local custom = timeSeries.fieldConfig.defaults.custom; +local defaults = timeSeries.fieldConfig.defaults; +local options = timeSeries.options; +base { + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/load_average.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/load_average.libsonnet new file mode 100644 index 0000000..d707a52 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/load_average.libsonnet @@ -0,0 +1,41 @@ +local g = import '../../../g.libsonnet'; +local generic = import '../../generic/timeSeries/main.libsonnet'; +local base = import './base.libsonnet'; +base { + + new( + title='Load average', + loadTargets, + cpuCountTarget, + description=||| + System load average over the previous 1, 5, and 15 minute ranges. + + A measurement of how many processes are waiting for CPU cycles. The maximum number is the number of CPU cores for the node. + ||| + ): + // validate inputs + std.prune( + { + checks: [ + if !(std.objectHas(cpuCountTarget, 'legendFormat')) then error 'cpuCountTarget must have legendFormat"', + ], + } + ) + + + local targets = loadTargets + [cpuCountTarget]; + super.new(title, targets, description) + // call directly threshold styler (not called from super automatically) + + self.stylizeCpuCores(cpuCountTarget.legendFormat), + + stylizeCpuCores(cpuCountName): + generic.threshold.stylizeByRegexp(cpuCountName), + + stylize(allLayers=true, cpuCountName=null): + (if allLayers then super.stylize() else {}) + + + g.panel.timeSeries.fieldConfig.defaults.custom.withFillOpacity(0) + + g.panel.timeSeries.standardOptions.withMin(0) + + g.panel.timeSeries.standardOptions.withUnit('short') + // this is only called if cpuCountName provided + + (if cpuCountName != null then self.stylizeCpuCores(cpuCountName) else {}), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/main.libsonnet new file mode 100644 index 0000000..d3e3b69 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/panels/system/timeSeries/main.libsonnet @@ -0,0 +1,4 @@ +{ + base: import './base.libsonnet', + loadAverage: import './load_average.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/README.md b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/README.md new file mode 100644 index 0000000..fa8bb0e --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/README.md @@ -0,0 +1,321 @@ +# Signal + +Status: experimental. + +This part of the lib allows to define signals (i.e. metrics, logs). + +This shifts focus of dashboard building from panels to actual signals we want to observe. + +Workflow to generate dashboards would be as follows: + +- Define key indicators(signals) your want to observe. +- Use built-in functions to render each signal as a panel (i.e. `signal.asTimeSeries()`, `signal.asStat()`, `signal.asGauge()`, `signal.asStatusHistory()`, `signal.asTable(format='table|time_series'))`, `signal.asTableColumn()`). +- If you need to put multiple signals inside a single panel use `signal.asPanelMixin()` function. It would add [Target](https://grafana.github.io/grafonnet/API/panel/timeSeries/index.html#fn-queryoptionswithtargets) and overrides relevant to it (units, value mappings...) +- If you need to put multiple columns inside single table use `signal.asTableColumn(format='table|time_series')` function. It would add `Target` And overrides relevant to it (units, value mappings...). +- Variables required for signals are also generated and can be attached to any dashboard. +- Bonus: use stylize() functions from commonlib/panels to apply common styles to signals. + +## Functions + +### Modify functions + +These functions modify one of the signal's property and then return signal back. Can be used as part of the builder pattern. + +- withTopK(limit=25) - wrap signal expression into topk(). +- withExprWrappersMixin(wrapper=[]) - wrap signal expression into additional function on top of existing wrappers. +- withOffset(offset) - add offset modifier to the expression. +- withFilteringSelectorMixin(mixin) - add additional selector to filteringSelector used. +- withQuantile(quantile=0.95) - add quantile modifier to the expression for histogram signals. + +### Render functions + +These functions return signals view as one of the Grafana panels, its part, or as alerts. + +- Panel functions + - asTimeSeries() - renders TimeSeries panel with signals expression as the the first target and panel override. + - asStat() - renders Stat panel with signals expression as the the first target and panel override. + - asGauge() - renders Gauge panel with signals expression as the the first target and panel override. + - asStatusHistory() - renders StatusHistory panel with signals expression as the the first target and panel override. + - asTable(format=table|time_series) - renders Table panel with signals expression as the the first target and panel override. +- Parts of panels + - asPanelMixin() - add signals expression as the the target and panel override to the existing panel of any type, except a table. + - asTableColumn(format=table|time_series) - add signals expression as the the target and panel override to the existing panel created with .asTable() function. + - asTarget() - add signals expression as the the target to the existing panel. + - asTableTarget() - add signals expression as the the target to the existing panel, with format=table. + - asOverride() - add panel override to the existing panel. + - asPanelExpression() - add signals expression to the panels target. +- Prometheus rules (alerts) + - asRuleExpression() - add signals expression without any Grafana dynamic variables inside. Can be used for Prometheus alerts and rules. + +## Autotransformations + +### Expressions +When one of built-in functions are used (asTimeSeries, asPanelsMixin, asTarget...) signals' base expressions are converted automatically based on the type: + +- counter: is wrapped into `([])` +- gauge: no transformation +- histogram: wrapped into `histogram_quantile(0.95, (rate([])) by (le,))` +- info: no transformation +- raw: no transformation. You can write your own complex expression and make sure is kept as is. + +Also, regardless of type (with the exception of `raw`), additional wrapper can be added when aggLevel `group` or `instance` is selected: + +` by () ()` + +## Configuration options + +Init level: + +|Name|Description|Possible values|Example value|Default value| +|-----|---|---|---|---| +|datasource| Prometheus Datasource name. |*|`custom_datasource`|`datasource`| +|datasourceLabel| Prometheus Datasource label. |*|`Custom data source`|`Data source`| +|filteringSelector|Used to filter metric scopes. Added to all dashboards'(as part of `queriesSelector`) and alerts' queries. |*|`[job="blablablah]"`,|`['job!=""']`| +|groupLabels| List of labels used to identify group of instance or whole service. |*|`[job]`|`[job]`| +|instanceLabels| List of labels used to identify single entity or specific service instance. |*|`[instance]`|`['instance']`| +|interval| The interval used in `counters` and `histogram` auto transformations. |1m,5m.1h..., $__rate_interval, $__interval...|`5m`,|`$__rate_interval`| +|alertsInterval| The interval used in `counters` and `histogram` auto transformations in alerts. Grafana's $__rate_interval or similar are not supported. |1m,5m.1h...|`5m`,|`5m`| +|aggLevel| Metrics aggregation level. |none, instance, group|`group`|`none`| +|aggKeepLabels| Extra labels to keep when aggregating with by() clause. |`['pool','level']`|`[]`| +|aggFunction| A function used to aggregate metrics. |avg,min,max,sum...|`sum`|`avg`| +|varMetric| A Metric used for variables discovery. |*|`up`|`node_uname_info`| +|legendCustomTemplate| A custom legend template could be defined with this to override automatic legend's generation|*|`null`|`{{instance}}`| +|rangeFunction| Rate function to use for counter metrics.|rate,irate,delta,idelta,increase|`rate`|`increase`| +|varAdHocEnabled| Attach ad hoc labels to variables generated. |`true`,`false`|`false`|`false`| +|varAdHocLabels| Limit ad hoc to the specific labels |*|`["environment"]`|`[]`| +|enableLokiLogs| Add additional loki datasource to variables generation |`true`,`false`|`true`|`false`| +|defaultSignalSource| Set default signal source (see below) | * | `prometheus` | + +Signal's level: + +|Name|Description|Possible values|Example value|Default value| +|-----|---|---|---|---| +|name|Signal's name. Used to populate panel's titles. |*|CPU utilization|-| +|nameShort|Signal's short name. Used to populate panel's legends and column names. |*|CPU|-| +|type|Signal's type. Depending on the type, some opinionated autotransformations would happen with queries, units. |gauge,counter,histogram,info,raw|gauge|-| +|optional| Set this signal optional.| true,false | false | false| +|unit| Signal's units. |*|bytes|``| +|description| Signal's description. Used to populate panel's description. |*|CPU usage time in percent.|``| +|sourceMaps[].expr| Signal's BASE expression in simplest form. Simplified jsonnet templating is supported (see below). Depending on signal's type(not `raw`) could autotransform to different form. |*|network_bytes_received_total{%(queriesSelector)s}|-| +|sourceMaps[].exprWrappers| Signal's additional wrapper functions that could be added as an array, [, ]. Functions would be applied AFTER any autotransformation takes place. |*|`['topk(10,',')']`|[]| +|aggLevel| Metrics aggregation level. |none, instance, group|`group`|`none`| +|aggFunction| A function used to aggregate metrics. |avg,min,max,sum...|`sum`|`avg`| +|sourceMaps[].aggKeepLabels| Extra labels to keep when aggregating with by() clause. |`['pool','level']`|`[]`| +|sourceMaps[].infoLabel| Only applicable to `info` metrics. Points to label name used to extract info. |*|-|-| +|sourceMaps[].valueMappings| Define signal's valueMappings in the same way defined in Grafana Dashboard Schema. |*|-|-| +|sourceMaps[].legendCustomTemplate| A custom legend template could be defined with this to override automatic legend's generation|*|`null`|`{{topic}}`| +|sourceMaps[].rangeFunction| Rate function to use for counter metrics.|rate,irate,delta,idelta,increase|`rate`|`increase`| +|sourceMaps[].quantile| Only applicable to `histogram` metrics. Defines quantile for histogram metrics. |0.01-0.99|`0.99`|`0.95`| + +## Expressions templating + +The following is supported in expressions and legends: + +- `%(queriesSelector)s` - expands to filteringSelector matchers and matchers based on instanceLabels, and groupLabels +- `%(queriesSelectorGroupOnly)s` - expands to filteringSelector matchers and matchers based on groupLabels only +- `%(queriesSelectorFilterOnly)s` - expands to filteringSelector matchers only +- `%(filteringSelector)s` - expands to filteringSelector matchers +- `%(groupLabels)s` - expands to groupLabels list +- `%(instanceLabels)s` - expands to instanceLabels list +- `%(agg)s` - expands to list of labels according to `aggLevel` and `aggKeepLabels` choosen +- `%(aggLegend)s` - expands to label in legend format (i.e. `{{}}`) according to `aggLevel` and `aggKeepLabels` choosen +- `%(aggFunction)s` - expands to aggregation function +- `%(interval)s` - expands to `interval` value +- `%(alertsInterval)s` - expands to `interval` value + +## Making signals optional + +When defining signals from multiple sources, you can make some of the signals optional. In this case, rendering will not throw a validation error that signal is missing for the specific source (and also in source defined as `defaultSignalSource`), while internal 'stub' type will be used and empty panel will be rendered instead. + +## Example 1: From JSON + +Define signals in json/jsonnet and unmarshall to signals. You can define multiple signals' sources: + +```jsonnet +//config.libsonnet + +local jsonSignals = + { + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + discoveryMetric: { + prometheus: 'up', + opentelemetry: 'target_info', + }, + signals: { + abc: { + name: 'ABC metric', + nameShort: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + sources: { + "prometheus": { + expr: 'abc_total{%(queriesSelector)s}', + }, + "opentelemetry": { + expr: 'otel_metric{%(queriesSelector)s}', + } + }, + }, + bar: { + name: 'BAR', + type: 'counter', + description: 'BAR', + unit: 'ns', + sources: { + "prometheus": { + expr: 'bar_total{%(queriesSelector)s}', + }, + "opentelemetry": { + expr: 'otel_bar{%(queriesSelector)s}', + } + }, + + }, + foo_info: { + name: 'foo info', + type: 'info', + description: 'foo', + unit: 'short', + optional: true, // set optional:true, if not all sources are available. + sources: { + "prometheus": { + expr: 'foo_info{%(queriesSelector)s}', + infoLabel: 'version', + }, + }, + + }, + status: { + name: 'Status', + type: 'gauge', + description: 'status', + unit: 'short', + optional: true, + sources: { + "prometheus": { + expr: 'status{%(queriesSelector)s}', + valueMappings: + [ + { + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + } + }, + ], + }, + }, + + }, + }, + }; + +local signals = signal.unmarshallJsonMulti(jsonSignals,type=['prometheus']); + +``` + +## Example 2: Generate 'combined' dashboard/alerts + +Same as example 1, but you can actually merge multiple sources together in one query by using 'or': + +```jsonnet +local jsonSignals = ; +local signals = signal.unmarshallJsonMulti(jsonSignals,type=['prometheus','opentelemetry]); +``` + +This would make your dashboards and alerts universal, suitable for multiple sources. + + +## Example 3: low-level + +Rarely used, but it is also possible to skip JSON unmarshalling: + +``` +local g = import 'g.libsonnet'; + +# define signals + local s = commonlib.signals.init( + datasource='datasource', + instanceLabels=['instance','device'], + groupLabels=['job'], + filteringSelector=['job=integrations/test'], + aggLevel='instance', + ), + + //prepare Grafana templated variables aligned with queriesSelector generated: + variables: s.getVariablesMultiChoice(), + + bytesIn: s.addSignal( + name='Bytes in', + nameShort='In', + type='counter', + unit='bytes', + description='Bytes in through interface', + sourceMaps=[ + { + expr: 'node_network_receive_bytes_total{%(queriesSelector)s}', + rangeFunction: null, + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], + ), + bytesOut: s.addSignal( + name='Bytes out', + nameShort='Out', + type='counter', + unit='bytes', + description='Bytes out through interface', + sourceMaps=[ + { + expr: 'node_network_transmit_bytes_total{%(queriesSelector)s}', + rangeFunction: null, + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], + + ), +}; + + + +#generate dashboard +g.dashboard.new('Device') ++ g.dashboard.withVariables(signals.variables) ++ g.dashboard.withPanels( + [ + g.panel.row.new('Graph'), + signals.bytesIn.asTimeSeries() + + g.panel.timeSeries.queryOptions.withTargetsMixin( + signals.bytesOut.asTarget() + ) + + { gridPos: { h: 10, w: 8 } } + + commonlib.panels.network.timeSeries.traffic.stylize() + + commonlib.panels.network.timeSeries.traffic.withNegateOutPackets(), + ] +) +``` + +## Running tests + +See test files +``` +cd common-lib +jsonnet -J vendor common/signal/test_histogram.libsonnet +``` diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/base.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/base.libsonnet new file mode 100644 index 0000000..7d9ed7c --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/base.libsonnet @@ -0,0 +1,413 @@ +local g = import '../g.libsonnet'; +local panels = import '../panels.libsonnet'; +local utils = import '../utils.libsonnet'; +local signalUtils = import './utils.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; +{ + new( + signalName, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): { + + local prometheusQuery = g.query.prometheus, + local this = self, + local hasValueMaps = std.length(this.getValueMappings(this.sourceMaps)) > 0, + local legendCustomTemplate = sourceMaps[0].legendCustomTemplate, + + sourceMaps:: sourceMaps, + combineUniqueExpressions(expressions):: + std.join( + if type == 'info' then '\nor ignoring(%s)\n' % std.join(',', this.combineUniqueInfoLabels(sourceMaps)) else '\nor\n', + std.uniq( // keep unique only + std.sort(expressions) + ) + ), + + combineUniqueKeepLabels(sourceMaps):: + std.uniq( // keep unique only + std.sort( + std.foldl(function(total, source) + total + + std.get(source, 'aggKeepLabels', []) + , sourceMaps, init=[]), + ) + ), + combineUniqueInfoLabels(sourceMaps):: + std.uniq( // keep unique only + std.sort( + std.foldl(function(total, source) + total + //keep infoLabel as well + + std.prune([std.get(source, 'infoLabel')]) + , sourceMaps, init=[]), + ) + ), + + //calculate aggKeepLabels to be used in legendLabelsCalculation + local aggKeepLabels = self.combineUniqueKeepLabels(this.sourceMaps), + infoLabels:: self.combineUniqueInfoLabels(this.sourceMaps), + vars:: + vars + { + //add additional templatedVars + aggLabels: + [] + + ( + if aggLevel == 'group' then super.groupLabels + else if aggLevel == 'instance' then super.groupLabels + super.instanceLabels + else if aggLevel == 'none' then [] + ) + + ( + if std.length(aggKeepLabels) > 0 then aggKeepLabels + else [] + ) + + ( + if std.length(this.infoLabels) > 0 then this.infoLabels + else [] + ), + agg: std.join(',', self.aggLabels), + + //prefix for legend when aggregation is used + local legendLabels = + [] + + + ( + if aggLevel == 'group' then super.groupLabels + else if aggLevel == 'instance' then super.instanceLabels + else if aggLevel == 'none' then super.instanceLabels + ), + aggLegend: utils.labelsToPanelLegend( + // keep last label + xtd.array.slice(legendLabels + aggKeepLabels, -1) + ), + aggFunction: aggFunction, + }, + + + unit:: signalUtils.generateUnits(type, unit, this.sourceMaps[0].rangeFunction), + + withOffset(offset): + this + { + sourceMaps: + [ + source + { + expr: '(%s offset %s)' % [source.expr, offset], + } + for source in this.sourceMaps + ], + }, + + withFilteringSelectorMixin(mixin): + this + { + vars+:: + { + filteringSelector: + [ + std.join( + ',', + std.filter(function(x) std.length(x) > 0, [ + this.vars.filteringSelector[0], + mixin, + ]) + ), + ], + queriesSelector+: ',' + mixin, + queriesSelectorGroupOnly+: ',' + mixin, + queriesSelectorFilterOnly+: ',' + mixin, + }, + }, + + withTopK(limit=25): + this + { + sourceMaps: + [ + source + { + exprWrappers+: [ + [ + 'topk(' + limit + ',', + ')', + ], + ], + } + for source in this.sourceMaps + ], + }, + + withExprWrappersMixin(wrappers=[]): + this + { + sourceMaps: + [ + source + { + exprWrappers+: [wrappers], + } + for source in this.sourceMaps + ], + }, + //Return as grafana panel target(query+legend) + asTarget(name=signalName): + prometheusQuery.new( + '${%s}' % datasource, + self.asPanelExpression(), + ) + + prometheusQuery.withRefId(name) + + prometheusQuery.withLegendFormat(signalUtils.wrapLegend(nameShort, aggLevel, legendCustomTemplate) % this.vars) + + prometheusQuery.withFormat('time_series') + + prometheusQuery.withInstant(false), + + //Useful to compose table with instant values + asTableTarget(): + self.asTarget() + + prometheusQuery.withFormat('table') + + prometheusQuery.withInstant(true), + + //Return as grafana panel mixin target(query+legend) + overrides(like units) + asPanelMixin(override='byQuery'): + g.panel.timeSeries.queryOptions.withTargetsMixin(self.asTarget()) + + self.asOverride(override=override), + + //Return table target (instant=true, format=table) + overrides + asTableColumn(override='byName', format='table'): + g.panel.table.queryOptions.withTargetsMixin( + if format == 'table' then self.asTableTarget() + else if format == 'time_series' then self.asTarget() + else error 'Unknown format, must be "table" or "time_series"' + ) + + self.asOverride(override=override, format=format), + + + getValueMappings(sourceMaps):: + std.uniq( + std.foldl(function(total, source) total + std.get(source, 'valueMappings', []), sourceMaps, init=[]) + ), + + asOverride(name=signalName, override='byQuery', format='time_series'): + g.panel.timeSeries.standardOptions.withOverridesMixin( + [ + if override == 'byQuery' then + g.panel.timeSeries.fieldOverride.byQuery.new(name) + + (if format == 'table' && hasValueMaps then g.panel.table.fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) else {}) + + (if format == 'table' && type == 'info' then g.panel.table.fieldOverride.byName.withProperty('custom.hidden', true) else {}) + + (if format == 'table' && name != nameShort then g.panel.table.fieldOverride.byName.withProperty('displayName', utils.toSentenceCase(nameShort)) else {}) + + g.panel.timeSeries.fieldOverride.byQuery.withPropertiesFromOptions( + (if hasValueMaps then + g.panel.timeSeries.standardOptions.withMappings(this.getValueMappings(sourceMaps)) + else {}) + + g.panel.timeSeries.standardOptions.withUnit(self.unit) + ) + else if override == 'byName' then + g.panel.timeSeries.fieldOverride.byName.new(name) + + (if format == 'table' && hasValueMaps then g.panel.table.fieldOverride.byName.withProperty('custom.cellOptions', { type: 'color-text' }) else {}) + + (if format == 'table' && type == 'info' then g.panel.table.fieldOverride.byName.withProperty('custom.hidden', true) else {}) + + (if format == 'table' && name != nameShort then g.panel.table.fieldOverride.byName.withProperty('displayName', utils.toSentenceCase(nameShort)) else {}) + + g.panel.timeSeries.fieldOverride.byName.withPropertiesFromOptions( + (if hasValueMaps then + g.panel.timeSeries.standardOptions.withMappings(this.getValueMappings(sourceMaps)) + else {}) + + g.panel.timeSeries.standardOptions.withUnit(self.unit) + ) + else error 'Unknown override type, only "byName", "byQuery" are supported.', + ], + ) + + (if type == 'info' && format == 'table' then + g.panel.timeSeries.standardOptions.withOverridesMixin( + [ + g.panel.timeSeries.fieldOverride.byName.new(infoLabel) + + g.panel.table.fieldOverride.byName.withProperty('displayName', utils.toSentenceCase(nameShort)) + for infoLabel in this.infoLabels + ], + ) + else {}), + //Return query + asPanelExpression(): + self.combineUniqueExpressions( + [ + //override aggLabels for specific source. + local aggLabels = + [] + + ( + if aggLevel == 'group' then this.vars.groupLabels + else if aggLevel == 'instance' then this.vars.groupLabels + this.vars.instanceLabels + else if aggLevel == 'none' then [] + ) + + ( + if std.length(source.aggKeepLabels) > 0 then source.aggKeepLabels + else [] + ) + + ( + //keep infoLabel as well when aggregating info signals + if source.infoLabel != null then [source.infoLabel] + else [] + ); + signalUtils.wrapExpr( + type, + source.expr, + exprWrappers=std.get(source, 'exprWrappers', default=[]), + q=std.get(source, 'quantile', default=0.95), + aggLevel=aggLevel, + rangeFunction=source.rangeFunction, + alertRule=false, + ).applyFunctions() + % this.vars { + agg: std.join(',', aggLabels), + } + for source in this.sourceMaps + ] + ), + + //Return query, usable in alerts/recording rules. + asRuleExpression(): + self.combineUniqueExpressions( + [ + //override aggLevel to 'none', to avoid loosing labels in alerts due to by() clause: + signalUtils.wrapExpr( + type, + source.expr, + exprWrappers=std.get(source, 'exprWrappers', default=[]), + q=std.get(source, 'quantile', default=0.95), + aggLevel='none', + rangeFunction=source.rangeFunction, + // ensure that interval doesn't have Grafana dashboard dynamic intervals: + alertRule=true, + ).applyFunctions() + % this.vars + { // ensure that interval doesn't have Grafana dashboard dynamic intervals: + interval: this.vars.alertsInterval, + // keep only filteringSelector, remove any Grafana dashboard variables: + queriesSelector: this.vars.filteringSelector[0], + queriesSelectorGroupOnly: this.vars.filteringSelector[0], + queriesSelectorFilterOnly: this.vars.filteringSelector[0], + } + for source in this.sourceMaps + ] + ), + + + common(type):: + // override panel-wide --mixed-- datasource + prometheusQuery.withDatasource('${%s}' % datasource) + + g.panel.timeSeries.panelOptions.withDescription(description) + + ( + if type == 'table' then {} + else + g.panel.timeSeries.queryOptions.withTargets( + self.asTarget() + ) + + self.asOverride() + ), + + //Return as timeSeriesPanel + asTimeSeries(name=signalName): + g.panel.timeSeries.new(name) + + self.common(type='timeSeries'), + + //Return as statPanel + asStat(name=signalName): + g.panel.stat.new(name) + + self.common(type='stat'), + // Return as table + // Table format: all targets must have format=table, instant=true, and matching labels set. + // Timeseries format: all targets must have format=timeseries, instant=false, and matching labels set. + // Useful to show Table trends. + asTable(name=signalName, format='table', filterable=false): + g.panel.table.new(name) + // https://github.com/grafana/grafonnet/issues/238 + // + g.panel.table.standardOptions.withFilterable(value=filterable) + + { + fieldConfig+: { + defaults+: { + custom+: { + filterable: filterable, + }, + }, + }, + } + + self.common(type='table') + + + if format == 'table' then + self.asTableColumn() + + g.panel.table.queryOptions.withTransformations( + [ + g.panel.table.queryOptions.transformation.withId('merge'), + g.panel.table.queryOptions.transformation.withId('renameByRegex') + + g.panel.table.queryOptions.transformation.withOptions({ + regex: 'Value #(.*)', + renamePattern: '$1', + }), + g.panel.table.queryOptions.transformation.withId('filterFieldsByName') + + g.panel.table.queryOptions.transformation.withOptions( + { + include: { + pattern: '^(?!Time).*$', + }, + } + ), + g.panel.table.queryOptions.transformation.withId('organize') + + g.panel.table.queryOptions.transformation.withOptions( + { + indexByName: { + [label.el]: label.index + for label in + std.mapWithIndex(function(i, e) { index: i, el: e }, this.vars.aggLabels) + }, + renameByName: + // If 'Value' is still present, then rename value to signal name. + // this is the case if only single query is used in the table. + { + Value: name, + } + + + { + [label]: utils.toSentenceCase(label) + for label in this.vars.aggLabels + }, + } + ), + ] + ) + else if format == 'time_series' then + self.asPanelMixin(override='byName') + + g.panel.table.queryOptions.withTransformations( + [ + g.panel.table.queryOptions.transformation.withId('timeSeriesTable'), + g.panel.table.queryOptions.transformation.withId('merge'), + g.panel.table.queryOptions.transformation.withId('renameByRegex') + + g.panel.table.queryOptions.transformation.withOptions({ + regex: 'Trend #(.*)', + renamePattern: '$1', + }), + ] + ) + else error 'Table format must be "time_series" or "table"', + + + //Return as gauge panel + asGauge(name=signalName): + g.panel.gauge.new(name) + + self.common(type='gauge'), + //Return as statusHistory + asStatusHistory(name=signalName): + g.panel.statusHistory.new(name) + + self.common(type='status-history') + // limit number of DPs + + g.panel.statusHistory.queryOptions.withMaxDataPoints(100) + + g.panel.statusHistory.standardOptions.color.withMode('fixed') + + g.panel.statusHistory.options.withShowValue('never'), + + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/counter.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/counter.libsonnet new file mode 100644 index 0000000..ec7114f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/counter.libsonnet @@ -0,0 +1,35 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; + +base { + new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + + { + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/gauge.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/gauge.libsonnet new file mode 100644 index 0000000..ad42ce9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/gauge.libsonnet @@ -0,0 +1,33 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; +base { + new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + { + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/histogram.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/histogram.libsonnet new file mode 100644 index 0000000..485e6e4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/histogram.libsonnet @@ -0,0 +1,47 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; + +base { + new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + + { + local this = self, + withQuantile(quantile=0.95): + self + { + sourceMaps: + [ + source + { + quantile: quantile, + } + for source in super.sourceMaps + ], + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/info.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/info.libsonnet new file mode 100644 index 0000000..851bbe5 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/info.libsonnet @@ -0,0 +1,74 @@ +local g = import '../g.libsonnet'; +local panels = import '../panels.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; + +//_info prometheus metric: something_info{}=1 +base { + new( + name, + type, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + 'short', + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + { + local prometheusQuery = g.query.prometheus, + local lokiQuery = g.query.loki, + local infoLabel = + std.join( + '|', + std.uniq( // keep unique only + std.sort( + [ + source.infoLabel + for source in sourceMaps + ] + ) + ) + ), + + unit:: 'short', + //Return as grafana panel target(query+legend) + asTarget():: + super.asTarget() + + prometheusQuery.withFormat('table'), + + //Return as alert/recordingRule query + asPromRule():: {}, + + //Return as timeSeriesPanel + asTimeSeries():: + error 'asTimeSeries() is not supported for info metrics. Use asStat() instead.', + + //Return as statPanel + asStat():: + super.asStat() + + panels.generic.stat.info.stylize() + //TODO update infoLabel to multi + { options+: { reduceOptions+: { fields: '/^(' + infoLabel + ')$/' } } }, + + //Return as gauge panel + asGauge():: + error 'asGauge() is not supported for info metrics. Use asStat() instead.', + + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/log.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/log.libsonnet new file mode 100644 index 0000000..bc46fe7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/log.libsonnet @@ -0,0 +1,68 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; +local lokiQuery = g.query.loki; +base { + new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + { + common(type):: + // override panel-wide --mixed-- datasource + lokiQuery.withDatasource('${%s}' % datasource) + + g.panel.logs.panelOptions.withDescription(description), + + + //Return as grafana panel target(query+legend) + asTarget(name=name): + lokiQuery.new( + '${%s}' % datasource, + self.asPanelExpression(), + ) + + lokiQuery.withRefId(name), + + asGauge():: + error 'asGauge() is not supported for log metrics.', + asStat():: + error 'asStat() is not supported for log metrics.', + asTimeSeries():: + error 'asTimeSeries() is not supported for log metrics.', + asTableTarget(): + error 'asTableTarget() is not supported for log metrics.', + asTableColumn(): + error 'asTableColumn() is not supported for log metrics.', + asTable(): + error 'asTable() is not supported for log metrics.', + asOverride(): + error 'asOverride() is not supported for log metrics.', + asStatusHistory(): + error 'asStatusHistory() is not supported for log metrics.', + withOffset(): + error 'withOffset() is not supported for log metrics.', + withTopK(): + error 'withTopK() is not supported for log metrics.', + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/raw.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/raw.libsonnet new file mode 100644 index 0000000..ec7114f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/raw.libsonnet @@ -0,0 +1,35 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local base = import './base.libsonnet'; +local signalUtils = import './utils.libsonnet'; + +base { + new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps, + ): + base.new( + name, + type, + unit, + nameShort, + description, + aggLevel, + aggFunction, + vars, + datasource, + sourceMaps=sourceMaps, + ) + + { + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/signal.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/signal.libsonnet new file mode 100644 index 0000000..05b3fc0 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/signal.libsonnet @@ -0,0 +1,371 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local variables = import '../variables/variables.libsonnet'; +local counter = import './counter.libsonnet'; +local gauge = import './gauge.libsonnet'; +local histogram = import './histogram.libsonnet'; +local info = import './info.libsonnet'; +local log = import './log.libsonnet'; +local raw = import './raw.libsonnet'; +local stub = import './stub.libsonnet'; +local xtd = import 'github.com/jsonnet-libs/xtd/main.libsonnet'; +{ + //Expected signalsJson format: + // { + // filteringSelector: 'job!=""', + // groupLabels: ['job'], + // instanceLabels: ['instance'], + // discoveryMetric: 'up', + // aggLevel: 'group' or 'instance' or 'none', + // aggFunction: 'avg', + // signals: { + // signal1: { + // name: 'Golang version', + // type: 'info', + // description: 'Golang version used.', + // expr: 'go_info{%(queriesSelector)s}', + // infoLabel: 'version', + // }, + // signal2:..., + // signal3:.... + // } + // } + // DEPRECATED. Use unmarshallJsonMulti instead. + unmarshallJson(signalsJson): + self.init( + datasource=std.get(signalsJson, 'datasource', if std.get(signalsJson, 'enableLokiLogs', false) then 'prometheus_datasource' else 'datasource'), + datasourceLabel=std.get(signalsJson, 'datasourceLabel', if std.get(signalsJson, 'enableLokiLogs', false) then 'Prometheus data source' else 'Data source'), + filteringSelector=[signalsJson.filteringSelector], + groupLabels=signalsJson.groupLabels, + instanceLabels=signalsJson.instanceLabels, + interval=std.get(signalsJson, 'interval', '$__rate_interval'), + alertsInterval=std.get(signalsJson, 'alertsInterval', '5m'), + varMetric=std.get(signalsJson, 'discoveryMetric', 'up'), + aggLevel=std.get(signalsJson, 'aggLevel', 'none'), + aggFunction=std.get(signalsJson, 'aggFunction', 'avg'), + aggKeepLabels=std.get(signalsJson, 'aggKeepLabels', []), + legendCustomTemplate=std.get(signalsJson, 'legendCustomTemplate', null), + rangeFunction=std.get(signalsJson, 'rangeFunction', 'rate'), // rate, irate , delta, increase, idelta... + varAdHocEnabled=std.get(signalsJson, 'varAdHocEnabled', false), + varAdHocLabels=std.get(signalsJson, 'varAdHocLabels', []), + enableLokiLogs=std.get(signalsJson, 'enableLokiLogs', false), + ) + + + { + [s]: super.addSignal( + name=std.get(signalsJson.signals[s], 'name', error 'Must provide name'), + type=std.get(signalsJson.signals[s], 'type', error 'Must provide type for signal %s' % signalsJson.signals[s].name), + unit=std.get(signalsJson.signals[s], 'unit', ''), + nameShort=std.get(signalsJson.signals[s], 'nameShort', signalsJson.signals[s].name), + description=std.get(signalsJson.signals[s], 'description', ''), + aggLevel=std.get(signalsJson.signals[s], 'aggLevel', signalsJson.aggLevel), + aggFunction=std.get(signalsJson.signals[s], 'aggFunction', std.get(signalsJson, 'aggFunction', 'avg')), + sourceMaps=[ + { + expr: std.get(signalsJson.signals[s], 'expr', error 'Must provide expression "expr" for signal %s' % signalsJson.signals[s].name), + exprWrappers: std.get(signalsJson.signals[s], 'exprWrappers', []), + rangeFunction: std.get(signalsJson.signals[s], 'rangeFunction', std.get(signalsJson, 'rangeFunction', 'rate')), // rate, irate , delta, increase, idelta... + aggFunction: std.get(signalsJson.signals[s], 'aggFunction', std.get(signalsJson, 'aggFunction', 'avg')), + aggKeepLabels: std.get(signalsJson.signals[s], 'aggKeepLabels', std.get(signalsJson, 'aggKeepLabels', [])), + infoLabel: std.get(signalsJson.signals[s], 'infoLabel', null), + type: std.get(signalsJson.signals[s], 'type', error 'Must provide type for signal %s' % signalsJson.signals[s].name), + legendCustomTemplate: std.get(signalsJson.signals[s], 'legendCustomTemplate', std.get(signalsJson, 'legendCustomTemplate', null)), + valueMappings: std.get(signalsJson.signals[s], 'valueMappings', []), + quantile: std.get(signalsJson.signals[s], 'quantile', 0.95), + }, + ], + ) + for s in std.objectFieldsAll(signalsJson.signals) + }, + + unmarshallJsonMulti(signalsJson, type='prometheus'): + + local typeArr = + ( + if std.type(type) == 'string' then + [type] + else //array + type + ); + local defaultSignalSource = std.get(signalsJson, 'defaultSignalSource', 'prometheus'); + + self.init( + datasource=std.get(signalsJson, 'datasource', if std.get(signalsJson, 'enableLokiLogs', false) then 'prometheus_datasource' else 'datasource'), + datasourceLabel=std.get(signalsJson, 'datasourceLabel', if std.get(signalsJson, 'enableLokiLogs', false) then 'Prometheus data source' else 'Data source'), + filteringSelector=[signalsJson.filteringSelector], + groupLabels=signalsJson.groupLabels, + instanceLabels=signalsJson.instanceLabels, + interval=std.get(signalsJson, 'interval', '$__rate_interval'), + alertsInterval=std.get(signalsJson, 'alertsInterval', '5m'), + varMetric=self.getVarMetric(signalsJson, type, defaultSignalSource), + aggLevel=std.get(signalsJson, 'aggLevel', 'none'), + aggFunction=std.get(signalsJson, 'aggFunction', 'avg'), + aggKeepLabels=std.get(signalsJson, 'aggKeepLabels', []), + legendCustomTemplate=std.get(signalsJson, 'legendCustomTemplate', null), + rangeFunction=std.get(signalsJson, 'rangeFunction', std.get(signalsJson, 'rangeFunction', 'rate')), // rate, irate , delta, increase, idelta... + varAdHocEnabled=std.get(signalsJson, 'varAdHocEnabled', false), + varAdHocLabels=std.get(signalsJson, 'varAdHocLabels', []), + enableLokiLogs=std.get(signalsJson, 'enableLokiLogs', false), + ) + + + { + [s]: + //validate name: + (if !std.objectHas(signalsJson.signals[s], 'name') then error ('Must provide name') else {}) + + if std.objectHas(signalsJson.signals[s], 'sources') && std.length(signalsJson.signals[s]) > 0 then + local name = std.get(signalsJson.signals[s], 'name', error 'Must provide name'); + local metricType = std.get(signalsJson.signals[s], 'type', error 'Must provide type for signal %s' % s); + local validatedArr = [ + if + std.get(signalsJson.signals[s], 'optional', false) == false + && + ( + !std.objectHas(signalsJson.signals[s].sources, sourceName) + && + !std.objectHas(signalsJson.signals[s].sources, defaultSignalSource) + ) + then error 'must provide source for signal %s of type=%s' % [s, sourceName] + else ( + if + std.objectHas(signalsJson.signals[s].sources, sourceName) then sourceName + else if + std.objectHas(signalsJson.signals[s].sources, defaultSignalSource) then defaultSignalSource + ) + for sourceName in typeArr + ]; + local sourceMaps = + [ + { + expr: std.get(source.value, 'expr', error 'Must provide expression "expr" for signal %s and type=%s' % [s, source.key]), + exprWrappers: std.get(source.value, 'exprWrappers', []), + rangeFunction: std.get(source.value, 'rangeFunction', std.get(signalsJson, 'rangeFunction', 'rate')), + aggFunction: std.get(source.value, 'aggFunction', std.get(signalsJson, 'aggFunction', 'avg')), + aggKeepLabels: std.get(source.value, 'aggKeepLabels', std.get(signalsJson, 'aggKeepLabels', [])), + infoLabel: std.get(source.value, 'infoLabel', null), + legendCustomTemplate: std.get(source.value, 'legendCustomTemplate', std.get(signalsJson, 'legendCustomTemplate', null)), + valueMappings: std.get(source.value, 'valueMappings', []), + quantile: std.get(source.value, 'quantile', 0.95), + } + for source in std.objectKeysValues(signalsJson.signals[s].sources) + if std.member(validatedArr, source.key) + ]; + + (if std.length(sourceMaps) > 0 then + + super.addSignal( + name=name, + type=metricType, + unit=std.get(signalsJson.signals[s], 'unit', ''), + nameShort=std.get(signalsJson.signals[s], 'nameShort', name), + description=std.get(signalsJson.signals[s], 'description', ''), + aggLevel=std.get(signalsJson.signals[s], 'aggLevel', signalsJson.aggLevel), + aggFunction=std.get(signalsJson.signals[s], 'aggFunction', std.get(signalsJson, 'aggFunction', 'avg')), + sourceMaps=sourceMaps + ) + else + super.addSignal( + name=std.get(signalsJson.signals[s], 'name', error 'Must provide name'), + nameShort=std.get(signalsJson.signals[s], 'nameShort', name), + type='stub', + description=std.get(signalsJson.signals[s], 'description', ''), + )) + + else error 'please provide sources for %s' % s + + for s in std.objectFieldsAll(signalsJson.signals) + }, + + init( + datasource='datasource', + datasourceLabel='Data source', + filteringSelector=['job!=""'], + groupLabels=['job'], + instanceLabels=['instance'], + interval='$__rate_interval', + // interval used in alert expressions + alertsInterval='5m', + //default aggregation level + aggLevel='none', + aggKeepLabels=[], + aggFunction='avg', + //metric used in variables discovery by default + varMetric='up', + legendCustomTemplate=null, + rangeFunction='rate', + varAdHocEnabled=false, + varAdHocLabels=[], + enableLokiLogs=false, + ): self { + + local this = self, + datasource:: if enableLokiLogs && datasource == 'datasource' then 'prometheus_datasource' else datasource, + datasourceLabel:: if enableLokiLogs && datasourceLabel == 'Data source' then 'Prometheus data source' else datasourceLabel, + aggLevel:: aggLevel, + aggKeepLabels:: aggKeepLabels, + aggFunction:: aggFunction, + + // vars used in dashboards' variables + local grafanaVariables = variables.new( + filteringSelector[0], + groupLabels, + instanceLabels, + varMetric=varMetric, + prometheusDatasourceName=this.datasource, + prometheusDatasourceLabel=this.datasourceLabel, + adHocEnabled=varAdHocEnabled, + adHocLabels=varAdHocLabels, + enableLokiLogs=enableLokiLogs, + ), + // vars are used in templating(legend+expressions) + templatingVariables: { + filteringSelector: filteringSelector, + groupLabels: groupLabels, + instanceLabels: instanceLabels, + queriesSelector: grafanaVariables.queriesSelector, + queriesSelectorGroupOnly: grafanaVariables.queriesSelectorGroupOnly, + queriesSelectorFilterOnly: grafanaVariables.queriesSelectorFilterOnly, + interval: interval, + alertsInterval: alertsInterval, + }, + //get Grafana Variables + //allow multiple instance selection + getVariablesSingleChoice():: + grafanaVariables.singleInstance, + //only single instance selection allowed + getVariablesMultiChoice():: + grafanaVariables.multiInstance, + getVariablesDatasource(type='prometheus'): + grafanaVariables.datasources[type], + + //name: metric simple name + //type: counter, gauge, histogram, raw, info, log + //unit: simple unit + //description: metric description + //exprTemplate: expression template + addSignal( + name, + type, + unit='short', + nameShort, + description, + aggLevel=self.aggLevel, + aggFunction=self.aggFunction, + sourceMaps=[ + { + expr: error 'must define expression', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: aggFunction, + aggKeepLabels: self.aggKeepLabels, + infoLabel: null, + type: type, + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ): + // validate inputs + std.prune( + { + checks: [ + if (type != 'gauge' && type != 'histogram' && type != 'counter' && type != 'raw' && type != 'info' && type != 'stub' && type != 'log') then error "type must be one of 'gauge','histogram','counter','raw','info','log'. Got %s for %s" % [type, name], + if (aggLevel != 'none' && aggLevel != 'instance' && aggLevel != 'group') then error "aggLevel must be one of 'group','instance' or 'none'", + ], + } + ) + + if type == 'gauge' then + gauge.new( + name=name, + type=type, + unit=unit, + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource=this.datasource, + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'raw' then + raw.new( + name=name, + type=type, + unit=unit, + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource=this.datasource, + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'counter' then + counter.new( + name=name, + type=type, + unit=unit, + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource=this.datasource, + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'histogram' then + histogram.new( + name=name, + type=type, + unit=unit, + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource=this.datasource, + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'log' then + log.new( + name=name, + type=type, + unit='none', + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource='loki_datasource', + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'info' then + info.new( + name=name, + type=type, + nameShort=nameShort, + description=description, + aggLevel=aggLevel, + aggFunction=aggFunction, + datasource=this.datasource, + vars=this.templatingVariables, + sourceMaps=sourceMaps, + ) + else if type == 'stub' then + stub.new( + signalName=name, + type=type, + ), + }, + + getVarMetric(signalsJson, type, defaultSignalSource): + if std.objectHas(signalsJson, 'discoveryMetric') + then + if std.type(type) == 'array' then + std.prune( + [std.get(signalsJson.discoveryMetric, t, std.get(signalsJson.discoveryMetric, defaultSignalSource, null)) for t in type] + ) + else + std.get(signalsJson.discoveryMetric, type, std.get(signalsJson.discoveryMetric, defaultSignalSource, 'up')) + else 'up', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/stub.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/stub.libsonnet new file mode 100644 index 0000000..1d6f4c4 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/stub.libsonnet @@ -0,0 +1,49 @@ +local g = import '../g.libsonnet'; +local utils = import '../utils.libsonnet'; +local signalUtils = import './utils.libsonnet'; +{ + new( + signalName, + type, + ): { + local this = self, + + withTopK(limit): this, + withOffset(offset): this, + withFilteringSelectorMixin(mixin): this, + withExprWrappersMixin(wrappers=[]): this, + asOverride(name=signalName, override='byQuery', format='time_series'): {}, + asTarget():: {}, + asTableTarget():: {}, + + //Return as grafana panel mixin target(query+legend) + overrides(like units) + asPanelMixin():: {}, + + asPanelExpression():: {}, + //Return query, usable in alerts/recording rules. No aggregation is applied. + asRuleExpression():: {}, + //Return as timeSeriesPanel + asTimeSeries(name=signalName):: + g.panel.text.new('') + + g.panel.text.panelOptions.withTransparent(true) + + g.panel.text.panelOptions.withDescription(name + ': Signal not found.') + + g.panel.text.options.withContent(''), + + //Return as statPanel + asStat(name=signalName):: + self.asTimeSeries(), + + asTable(name=signalName, format):: + self.asTimeSeries(), + + asStatusHistory(name=signalName):: + self.asTimeSeries(), + + //Return as timeSeriesPanel + asGauge(name=signalName):: + self.asTimeSeries(), + + asTableColumn(override, format):: {}, + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter.libsonnet new file mode 100644 index 0000000..4795f76 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter.libsonnet @@ -0,0 +1,72 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)', + }, + }), + }, + asTimeSeries: + { + local raw = m1.asTimeSeries(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: 'API server requests', + }, + testUnit: { + actual: raw.fieldConfig.overrides[0].properties[0].value, + expect: 'rps', + }, + testTStype: { + actual: raw.type, + expect: 'timeseries', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter_with_enableLokiLogs.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter_with_enableLokiLogs.libsonnet new file mode 100644 index 0000000..cf2d969 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_counter_with_enableLokiLogs.libsonnet @@ -0,0 +1,73 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', + enableLokiLogs=true, +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)', + }, + }), + }, + asTimeSeries: + { + local raw = m1.asTimeSeries(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: 'API server requests', + }, + testUnit: { + actual: raw.fieldConfig.overrides[0].properties[0].value, + expect: 'rps', + }, + testTStype: { + actual: raw.type, + expect: 'timeseries', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${prometheus_datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_gauge.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_gauge.libsonnet new file mode 100644 index 0000000..2c54978 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_gauge.libsonnet @@ -0,0 +1,105 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local gauge1 = signal.init( + aggLevel='group', + filteringSelector=['job="integrations/agent"'], +).addSignal( + name='Up metric', + nameShort='Up', + type='gauge', + unit='short', + description='abc', + sourceMaps=[ + { + expr: 'up{%(queriesSelector)s}', + rangeFunction: null, + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + valueMappings: [{ + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + }, + }], + }, + ] +); + +{ + + asTarget: { + raw:: gauge1.asTarget(), + testResult: test.suite({ + testLegend: { + actual: gauge1.asTarget().legendFormat, + expect: '{{job}}: Up', + }, + testExpression: { + actual: gauge1.asTarget().expr, + expect: 'avg by (job) (\n up{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + }), + }, + asTargetWithcombinedTransformations: { + local raw = gauge1 + .withTopK(3) + .withOffset('30m') + .withFilteringSelectorMixin('region="us-east"') + .asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'topk(3,\n avg by (job) (\n (up{job="integrations/agent",job=~"$job",instance=~"$instance",region="us-east"} offset 30m)\n)\n)', + }, + testLegend: { + actual: raw.legendFormat, + expect: '{{job}}: Up', + }, + }), + }, + asTimeSeries: + { + local raw = gauge1.asTimeSeries(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: 'Up metric', + }, + testUnit: { + actual: raw.fieldConfig.overrides[0].properties[1].value, + expect: 'short', + }, + testValueMapping: { + actual: raw.fieldConfig.overrides[0].properties[0].value, + expect: [{ options: { '0': { color: 'light-red', index: 0, text: 'Down' }, '1': { color: 'light-green', index: 1, text: 'Up' } }, type: 'value' }], + }, + testTStype: { + actual: raw.type, + expect: 'timeseries', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_histogram.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_histogram.libsonnet new file mode 100644 index 0000000..a7d969c --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_histogram.libsonnet @@ -0,0 +1,103 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='10m', + aggLevel='group', + aggFunction='avg', +).addSignal( + name='API server duration', + nameShort='duration', + type='histogram', + unit='seconds', + description='API server call duration.', + sourceMaps=[ + { + expr: 'apiserver_request_duration_seconds_bucket{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], + +); + +{ + asTarget: { + local raw = m1.asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{job}}: duration', + }, + testExpression: { + actual: raw.expr, + expect: 'histogram_quantile(0.95, sum(rate(apiserver_request_duration_seconds_bucket{job="abc",job=~"$job",instance=~"$instance"}[10m])) by (le,job))', + }, + }), + }, + asTimeSeries: + { + local raw = m1.asTimeSeries(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: 'API server duration', + }, + testUnit: { + actual: raw.fieldConfig.overrides[0].properties[0].value, + expect: 'seconds', + }, + testTStype: { + actual: raw.type, + expect: 'timeseries', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + withCustomQuantile: { + local customHistogram = signal.init( + filteringSelector=['job="abc"'], + interval='10m', + aggLevel='group', + aggFunction='avg', + ).addSignal( + name='Custom quantile', + nameShort='p99', + type='histogram', + unit='seconds', + description='99th percentile', + + sourceMaps=[{ + expr: 'http_request_duration_seconds_bucket{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: ['handler'], + quantile: 0.99, + infoLabel: null, + }], + ), + + testResult: test.suite({ + testDefaultQuantile: { + actual: customHistogram.asTarget().expr, + expect: 'histogram_quantile(0.99, sum(rate(http_request_duration_seconds_bucket{job="abc",job=~"$job",instance=~"$instance"}[10m])) by (le,job,handler))', + }, + testCustomQuantile: { + actual: customHistogram.withQuantile(quantile=0.50).asTarget().expr, + expect: 'histogram_quantile(0.50, sum(rate(http_request_duration_seconds_bucket{job="abc",job=~"$job",instance=~"$instance"}[10m])) by (le,job,handler))', + }, + }), + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info.libsonnet new file mode 100644 index 0000000..eeeacc2 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info.libsonnet @@ -0,0 +1,63 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], +).addSignal( + name='Go version', + nameShort='Version', + type='info', + aggLevel='instance', + description='Go version.', + sourceMaps=[ + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version', + legendCustomTemplate: null, + aggKeepLabels: [], + }, + ] +); + +{ + + asTarget: { + raw:: m1.asTarget(), + testResult: test.suite({ + testExpression: { + actual: m1.asTarget().expr, + expect: 'avg by (job,instance,version) (\n go_info{job="abc",job=~"$job",instance=~"$instance"}\n)', + }, + }), + }, + asStat: + { + raw:: m1.asStat(), + testResult: test.suite({ + testTStitle: { + actual: m1.asStat().title, + expect: 'Go version', + }, + testType: { + actual: m1.asStat().type, + expect: 'stat', + }, + testTSversion: { + actual: m1.asStat().pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: m1.asStat().datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + testInfoLabel: { + actual: m1.asStat().options.reduceOptions.fields, + expect: '/^(' + 'version' + ')$/', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info_combined.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info_combined.libsonnet new file mode 100644 index 0000000..8d79d93 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_info_combined.libsonnet @@ -0,0 +1,74 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], +).addSignal( + name='Go version', + nameShort='Version', + type='info', + description='Go version.', + sourceMaps=[ + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version', + aggKeepLabels: [], + legendCustomTemplate: null, + }, + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version2', + aggKeepLabels: [], + legendCustomTemplate: null, + }, + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version', + aggKeepLabels: [], + legendCustomTemplate: null, + }, + ] +); + +{ + + asTarget: { + local raw = m1.asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'go_info{job="abc",job=~"$job",instance=~"$instance"}', + }, + }), + }, + asStat: + { + local raw = m1.asStat(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: 'Go version', + }, + testType: { + actual: raw.type, + expect: 'stat', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + testInfoLabel: { + actual: raw.options.reduceOptions.fields, + expect: '/^' + '(version|version2)' + '$/', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_log.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_log.libsonnet new file mode 100644 index 0000000..f7c92ed --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_log.libsonnet @@ -0,0 +1,44 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['foo="bar"'], + interval='10m', + aggLevel='group', + aggFunction='avg', +).addSignal( + name='Log query', + nameShort='Log', + type='log', + unit='none', + description='Log query.', + sourceMaps=[ + { + expr: '{%(queriesSelector)s} | json', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], + +); + +{ + asTarget: { + local raw = m1.asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: '{foo="bar",job=~"$job",instance=~"$instance"} | json', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${loki_datasource}', + type: 'loki', + }, + }, + }), + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json.libsonnet new file mode 100644 index 0000000..a0a8f93 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json.libsonnet @@ -0,0 +1,137 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local jsonSignals = + { + datasource: 'custom_datasource', + datasourceLabel: 'Custom datasource', + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + discoveryMetric: 'up2', + signals: { + abc: { + name: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + expr: 'abc{%(queriesSelector)s}', + }, + bar: { + name: 'BAR', + type: 'counter', + description: 'BAR', + unit: 'ns', + expr: 'bar{%(queriesSelector)s}', + }, + foo_info: { + name: 'foo info', + type: 'info', + description: 'foo', + unit: 'short', + infoLabel: 'version', + expr: 'foo_info{%(queriesSelector)s}', + }, + status: { + name: 'Status', + type: 'gauge', + description: 'status', + unit: 'short', + expr: 'status{%(queriesSelector)s}', + valueMapping: { + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + }, + }, + }, + }, + }; + +local signals = signal.unmarshallJson(jsonSignals); + +{ + multiChoice: { + local raw = signals.getVariablesMultiChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Custom datasource', name: 'custom_datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${custom_datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${custom_datasource}' }, includeAll: true, label: 'Instance', multi: true, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + singleChoice: { + local raw = signals.getVariablesSingleChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Custom datasource', name: 'custom_datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${custom_datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${custom_datasource}' }, includeAll: false, label: 'Instance', multi: false, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + asTarget: { + local panel = signals.abc.asTarget(), + raw:: panel, + testResult: test.suite({ + testExpression: { + actual: panel.expr, + expect: 'avg by (job) (\n abc{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + }), + }, + asStatusHistory: + { + local panel = signals.bar.asStatusHistory(), + raw:: panel, + testResult: test.suite({ + testTitle: { + actual: panel.title, + expect: 'BAR', + }, + testType: { + actual: panel.type, + expect: 'status-history', + }, + testVersion: { + actual: panel.pluginVersion, + expect: 'v11.0.0', + }, + testUid: { + actual: panel.datasource, + expect: { + uid: '${custom_datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi.libsonnet new file mode 100644 index 0000000..051d5ac --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi.libsonnet @@ -0,0 +1,168 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local jsonSignals = + { + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + aggKeepLabels: ['xxx'], + discoveryMetric: { + otel: 'up2', + }, + signals: { + abc: { + name: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + sources: { + otel: { + expr: 'abc{%(queriesSelector)s}', + }, + prometheus: { + expr: 'abc{%(queriesSelector)s}', + }, + }, + }, + bar: { + name: 'BAR', + type: 'counter', + description: 'BAR', + unit: 'ns', + sources: { + otel: { + expr: 'bar{%(queriesSelector)s}', + aggKeepLabels: ['bar'], + }, + prometheus: { + expr: 'bar{%(queriesSelector)s}', + }, + }, + }, + foo_info: { + name: 'foo info', + type: 'info', + description: 'foo', + unit: 'short', + sources: { + otel: { + expr: 'foo_info{%(queriesSelector)s}', + + infoLabel: 'version', + }, + prometheus: {}, + }, + }, + status: { + name: 'Status', + type: 'gauge', + description: 'status', + unit: 'short', + sources: { + otel: { + expr: 'status{%(queriesSelector)s}', + valueMapping: { + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + }, + }, + }, + }, + + }, + }, + }; + +local signals = signal.unmarshallJsonMulti(jsonSignals, 'otel'); + +{ + multiChoice: { + local raw = signals.getVariablesMultiChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Instance', multi: true, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + singleChoice: { + local raw = signals.getVariablesSingleChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: false, label: 'Instance', multi: false, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + asTarget: { + local panel = signals.abc.asTarget(), + raw:: panel, + testResult: test.suite({ + testExpression: { + actual: panel.expr, + expect: 'avg by (job,xxx) (\n abc{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + testLegend: { + actual: panel.legendFormat, + expect: '{{xxx}}: ABC', // only last label is kept + }, + }), + }, + asStatusHistory: + { + local panel = signals.bar.asStatusHistory(), + raw:: panel, + testResult: test.suite({ + testTitle: { + actual: panel.title, + expect: 'BAR', + }, + testType: { + actual: panel.type, + expect: 'status-history', + }, + testVersion: { + actual: panel.pluginVersion, + expect: 'v11.0.0', + }, + testUid: { + actual: panel.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_combined.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_combined.libsonnet new file mode 100644 index 0000000..7e03a2c --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_combined.libsonnet @@ -0,0 +1,179 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local jsonSignals = + { + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + aggKeepLabels: ['xxx'], + discoveryMetric: { + otel: 'up2', + prometheus: 'up3', + }, + signals: { + abc: { + name: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + sources: { + otel: { + expr: 'abc2{%(queriesSelector)s}', + }, + prometheus: { + expr: 'abc{%(queriesSelector)s}', + aggKeepLabels: ['abc'], + }, + }, + }, + bar: { + name: 'BAR', + type: 'counter', + description: 'BAR', + unit: 'ns', + sources: { + otel: { + expr: 'bar{%(queriesSelector)s}', + }, + prometheus: { + expr: 'bar{%(queriesSelector)s}', + aggKeepLabels: ['bar'], + }, + }, + }, + foo_info: { + name: 'foo info', + type: 'info', + description: 'foo', + unit: 'short', + sources: { + otel: { + expr: 'foo_info{%(queriesSelector)s}', + infoLabel: 'version', + }, + prometheus: { + expr: 'foo_info2{%(queriesSelector)s}', + infoLabel: 'version2', + }, + }, + }, + status: { + name: 'Status', + type: 'gauge', + description: 'status', + unit: 'short', + sources: { + otel: { + expr: 'status{%(queriesSelector)s}', + valueMappings: [ + { + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + }, + }, + ], + }, + }, + + }, + }, + }; + +local signals = signal.unmarshallJsonMulti(jsonSignals, ['otel', 'prometheus']); + +{ + multiChoice: { + local raw = signals.getVariablesMultiChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values({__name__=~"up2|up3",job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Instance', multi: true, name: 'instance', query: 'label_values({__name__=~"up2|up3",job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + singleChoice: { + local raw = signals.getVariablesSingleChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values({__name__=~"up2|up3",job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: false, label: 'Instance', multi: false, name: 'instance', query: 'label_values({__name__=~"up2|up3",job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + asTarget: { + local panel = signals.abc.asTarget(), + raw:: panel, + testResult: test.suite({ + testExpression: { + actual: panel.expr, + expect: 'avg by (job,abc) (\n abc{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)\nor\navg by (job,xxx) (\n abc2{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + }), + }, + asTargetInfo: { + local raw = signals.foo_info.asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'avg by (job,xxx,version) (\n foo_info{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)\nor ignoring(version,version2)\navg by (job,xxx,version2) (\n foo_info2{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + }), + }, + asStatusHistory: + { + local panel = signals.bar.asStatusHistory(), + raw:: panel, + testResult: test.suite({ + testTitle: { + actual: panel.title, + expect: 'BAR', + }, + testType: { + actual: panel.type, + expect: 'status-history', + }, + testVersion: { + actual: panel.pluginVersion, + expect: 'v11.0.0', + }, + testUid: { + actual: panel.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_withEnableLokiLogs.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_withEnableLokiLogs.libsonnet new file mode 100644 index 0000000..e20d84b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_marshall_json_multi_withEnableLokiLogs.libsonnet @@ -0,0 +1,177 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local jsonSignals = + { + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + aggKeepLabels: ['xxx'], + enableLokiLogs: true, + discoveryMetric: { + otel: 'up2', + }, + signals: { + abc: { + name: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + sources: { + otel: { + expr: 'abc{%(queriesSelector)s}', + }, + prometheus: { + expr: 'abc{%(queriesSelector)s}', + }, + }, + }, + bar: { + name: 'BAR', + type: 'counter', + description: 'BAR', + unit: 'ns', + sources: { + otel: { + expr: 'bar{%(queriesSelector)s}', + aggKeepLabels: ['bar'], + }, + prometheus: { + expr: 'bar{%(queriesSelector)s}', + }, + }, + }, + foo_info: { + name: 'foo info', + type: 'info', + description: 'foo', + unit: 'short', + sources: { + otel: { + expr: 'foo_info{%(queriesSelector)s}', + + infoLabel: 'version', + }, + prometheus: {}, + }, + }, + status: { + name: 'Status', + type: 'gauge', + description: 'status', + unit: 'short', + sources: { + otel: { + expr: 'status{%(queriesSelector)s}', + valueMapping: { + type: 'value', + options: { + '1': { + text: 'Up', + color: 'light-green', + index: 1, + }, + '0': { + text: 'Down', + color: 'light-red', + index: 0, + }, + }, + }, + }, + }, + + }, + }, + }; + +local signals = signal.unmarshallJsonMulti(jsonSignals, 'otel'); + +{ + multiChoice: { + local raw = signals.getVariablesMultiChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Prometheus data source', name: 'prometheus_datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${prometheus_datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${prometheus_datasource}' }, includeAll: true, label: 'Instance', multi: true, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + testLokiDs: { + actual: raw[3], + expect: { hide: 2, label: 'Loki data source', name: 'loki_datasource', query: 'loki', regex: '', type: 'datasource' }, + }, + }), + }, + singleChoice: { + local raw = signals.getVariablesSingleChoice(), + raw:: raw, + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Prometheus data source', name: 'prometheus_datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${prometheus_datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up2{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${prometheus_datasource}' }, includeAll: false, label: 'Instance', multi: false, name: 'instance', query: 'label_values(up2{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + testLokiDs: { + actual: raw[3], + expect: { hide: 2, label: 'Loki data source', name: 'loki_datasource', query: 'loki', regex: '', type: 'datasource' }, + }, + }), + }, + asTarget: { + local panel = signals.abc.asTarget(), + raw:: panel, + testResult: test.suite({ + testExpression: { + actual: panel.expr, + expect: 'avg by (job,xxx) (\n abc{job="integrations/agent",job=~"$job",instance=~"$instance"}\n)', + }, + testLegend: { + actual: panel.legendFormat, + expect: '{{xxx}}: ABC', // only last label is kept + }, + }), + }, + asStatusHistory: + { + local panel = signals.bar.asStatusHistory(), + raw:: panel, + testResult: test.suite({ + testTitle: { + actual: panel.title, + expect: 'BAR', + }, + testType: { + actual: panel.type, + expect: 'status-history', + }, + testVersion: { + actual: panel.pluginVersion, + expect: 'v11.0.0', + }, + testUid: { + actual: panel.datasource, + expect: { + uid: '${prometheus_datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_queriesSelector_templates.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_queriesSelector_templates.libsonnet new file mode 100644 index 0000000..8a6da3d --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_queriesSelector_templates.libsonnet @@ -0,0 +1,251 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +{ + queriesSelectorGroupOnly: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + ), + + local testSignal = signalInit.addSignal( + name='Test metric', + nameShort='test', + type='gauge', + unit='short', + description='Test metric', + sourceMaps=[ + { + expr: 'test_metric{%(queriesSelectorGroupOnly)s}', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'gauge', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'avg by (job) (\n test_metric{job="integrations/agent",job=~"$job"}\n)', + }, + }), + }, + + queriesSelectorFilterOnly: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + ), + + local testSignal = signalInit.addSignal( + name='Test metric', + nameShort='test', + type='gauge', + unit='short', + description='Test metric', + sourceMaps=[ + { + expr: 'test_metric{%(queriesSelectorFilterOnly)s}', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'gauge', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'avg by (job) (\n test_metric{job="integrations/agent"}\n)', + }, + }), + }, + + // Test asRuleExpression - returns expression without Grafana variables, suitable for alerts + asRuleExpression: { + // Test with gauge type + gauge: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + alertsInterval='5m', + ), + + local testSignal = signalInit.addSignal( + name='Test metric', + nameShort='test', + type='gauge', + unit='short', + description='Test metric', + sourceMaps=[ + { + expr: 'test_metric{%(queriesSelector)s}', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'gauge', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.asRuleExpression(), + testResult: test.suite({ + testExpression: { + actual: raw, + expect: 'test_metric{job="integrations/agent"}', + }, + }), + }, + + // Test with counter type + counter: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + alertsInterval='5m', + ), + + local testSignal = signalInit.addSignal( + name='Test counter', + nameShort='counter', + type='counter', + unit='requests', + description='Test counter', + sourceMaps=[ + { + expr: 'test_counter_total{%(queriesSelector)s}', + exprWrappers: [], + rangeFunction: 'increase', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'counter', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.asRuleExpression(), + testResult: test.suite({ + testExpression: { + actual: raw, + expect: 'increase(test_counter_total{job="integrations/agent"}[5m:] offset -5m)', + }, + }), + }, + }, + + // Test withFilteringSelectorMixin - adds additional filtering selector + withFilteringSelectorMixin: { + // Test basic filtering selector mixin + basic: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + ), + + local testSignal = signalInit.addSignal( + name='Test metric', + nameShort='test', + type='gauge', + unit='short', + description='Test metric', + sourceMaps=[ + { + expr: 'test_metric{%(queriesSelector)s}', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'gauge', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.withFilteringSelectorMixin('environment="prod"').asTarget(), + testResult: test.suite({ + testExpression: { + actual: raw.expr, + expect: 'avg by (job) (\n test_metric{job="integrations/agent",job=~"$job",instance=~"$instance",environment="prod"}\n)', + }, + }), + }, + + // Test filtering selector mixin with asRuleExpression + withAsRuleExpression: { + local signalInit = signal.init( + filteringSelector=['job="integrations/agent"'], + groupLabels=['job'], + instanceLabels=['instance'], + aggLevel='group', + alertsInterval='5m', + ), + + local testSignal = signalInit.addSignal( + name='Test metric', + nameShort='test', + type='gauge', + unit='short', + description='Test metric', + sourceMaps=[ + { + expr: 'test_metric{%(queriesSelector)s}', + exprWrappers: [], + rangeFunction: 'rate', + aggFunction: 'avg', + aggKeepLabels: [], + infoLabel: null, + type: 'gauge', + legendCustomTemplate: null, + valueMappings: [], + quantile: 0.95, + }, + ], + ), + + local raw = testSignal.withFilteringSelectorMixin('environment="prod"').asRuleExpression(), + testResult: test.suite({ + testExpression: { + actual: raw, + expect: 'test_metric{job="integrations/agent",environment="prod"}', + }, + }), + }, + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_stub.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_stub.libsonnet new file mode 100644 index 0000000..8b196cb --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_stub.libsonnet @@ -0,0 +1,60 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], +).addSignal( + name='Go version', + nameShort='Version', + type='stub', + aggLevel='instance', + description='Go version.', + sourceMaps=[ + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version', + legendCustomTemplate: null, + aggKeepLabels: [], + }, + ] +); + +{ + + asStat: + { + local raw = m1.asStat(), + testResult: test.suite({ + testTStitle: { + actual: raw.title, + expect: '', // empty title for stub panels + }, + testType: { + actual: raw.type, + expect: 'text', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '-- Mixed --', + type: 'datasource', + }, + }, + }), + }, + asTableTarget: + { + local raw = m1.asTableTarget(), + testResult: test.suite({ + testTStitle: { + actual: raw, + expect: {}, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table.libsonnet new file mode 100644 index 0000000..fff8081 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table.libsonnet @@ -0,0 +1,169 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='Requests', + type='counter', + unit='rps', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], + + +); + +{ + + asTableColumn: { + local raw = m1.asTableColumn(), + testResult: test.suite({ + testFormat: { + actual: m1.asTableColumn().targets[0].format, + expect: 'table', + }, + testExpression: { + actual: m1.asTableColumn().targets[0].expr, + expect: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)', + }, + testInstant: { + actual: m1.asTableColumn().targets[0].instant, + expect: true, + }, + testColumnTitle: { + actual: m1.asTable().fieldConfig.overrides[0].properties[0].value, + expect: 'Requests', + }, + testUnit: { + actual: m1.asTable().fieldConfig.overrides[0].properties[1].value, + expect: 'rps', + }, + }), + }, + asTableColumnWithTimeSeries: { + raw:: m1.asTableColumn(format='time_series'), + testResult: test.suite({ + testFormat: { + actual: m1.asTableColumn(format='time_series').targets[0].format, + expect: 'time_series', + }, + testExpression: { + actual: m1.asTableColumn(format='time_series').targets[0].expr, + expect: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)', + }, + testInstant: { + actual: m1.asTableColumn(format='time_series').targets[0].instant, + expect: false, + }, + }), + }, + asTable: + { + local raw = m1.asTable(), + testResult: test.suite({ + testRaw: { + actual: raw, + expect: { + datasource: + { type: 'prometheus', uid: '${datasource}' }, + description: 'API server calls.', + fieldConfig: { defaults: { custom: { filterable: false } }, overrides: [{ matcher: { id: 'byName', options: 'API server requests' }, properties: [{ id: 'displayName', value: 'Requests' }, { id: 'unit', value: 'rps' }] }] }, + pluginVersion: 'v11.0.0', + targets: [{ datasource: { type: 'prometheus', uid: '${datasource}' }, expr: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)', format: 'table', instant: true, legendFormat: '{{instance}}: Requests', refId: 'API server requests' }], + title: 'API server requests', + transformations: [ + { id: 'merge' }, + { id: 'renameByRegex', options: { regex: 'Value #(.*)', renamePattern: '$1' } }, + { id: 'filterFieldsByName', options: { include: { pattern: '^(?!Time).*$' } } }, + { + id: 'organize', + options: + { + indexByName: { instance: 1, job: 0 }, + renameByName: + { + Value: 'API server requests', + instance: 'Instance', + job: 'Job', + }, + + }, + }, + ], + type: 'table', + }, + }, + testTransformations: { + actual: raw.transformations, + expect: [ + { id: 'merge' }, + { + id: 'renameByRegex', + options: { + regex: 'Value #(.*)', + renamePattern: '$1', + }, + }, + { + id: 'filterFieldsByName', + options: { include: { pattern: '^(?!Time).*$' } }, + }, + { + // Sort instance and job labels first + // Capitalize instance and job labels + id: 'organize', + options: { + indexByName: { instance: 1, job: 0 }, + renameByName: + { + Value: 'API server requests', + instance: 'Instance', + job: 'Job', + }, + }, + }, + ], + }, + testTStitle: { + actual: raw.title, + expect: 'API server requests', + }, + testColumnTitle: { + actual: raw.fieldConfig.overrides[0].properties[0].value, + expect: 'Requests', + }, + testUnit: { + actual: raw.fieldConfig.overrides[0].properties[1].value, + expect: 'rps', + }, + testTStype: { + actual: raw.type, + expect: 'table', + }, + testTSversion: { + actual: raw.pluginVersion, + expect: 'v11.0.0', + }, + testTSUid: { + actual: raw.datasource, + expect: { + uid: '${datasource}', + type: 'prometheus', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table_info_column.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table_info_column.libsonnet new file mode 100644 index 0000000..20e5626 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_table_info_column.libsonnet @@ -0,0 +1,63 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], +).addSignal( + name='Go version', + nameShort='Version', + type='info', + aggLevel='instance', + description='Go version.', + sourceMaps=[ + { + expr: 'go_info{%(queriesSelector)s}', + infoLabel: 'version', + legendCustomTemplate: null, + aggKeepLabels: [], + }, + ] +); + +{ + asTableColumn: + { + local raw = m1.asTableColumn(), + testResult: test.suite({ + testOverrides: { + actual: raw.fieldConfig.overrides, + expect: [ + //hide value + { + matcher: { id: 'byName', options: 'Go version' }, + properties: [ + { id: 'custom.hidden', value: true }, + { id: 'displayName', value: 'Version' }, + { id: 'unit', value: 'short' }, + ], + }, + //show infoLabel as column instead: + { + matcher: { id: 'byName', options: 'version' }, + properties: [{ id: 'displayName', value: 'Version' }], + }, + ], + }, + testTargets: { + actual: raw.targets, + expect: [ + { + datasource: { type: 'prometheus', uid: '${datasource}' }, + expr: 'avg by (job,instance,version) (\n go_info{job="abc",job=~"$job",instance=~"$instance"}\n)', + format: 'table', + instant: true, + legendFormat: '{{instance}}: Version', + refId: 'Go version', + }, + ], + }, + + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables.libsonnet new file mode 100644 index 0000000..c24b2aa --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables.libsonnet @@ -0,0 +1,45 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local signalInit = signal.init( + aggLevel='group', + filteringSelector=['job="integrations/agent"'], +); + +{ + multiChoice: { + local raw = signalInit.getVariablesMultiChoice(), + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Instance', multi: true, name: 'instance', query: 'label_values(up{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + singleChoice: { + local raw = signalInit.getVariablesSingleChoice(), + testResult: test.suite({ + testDS: { + actual: raw[0], + expect: { label: 'Data source', name: 'datasource', query: 'prometheus', regex: '', type: 'datasource' }, + }, + testGroupSelector: { + actual: raw[1], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: true, label: 'Job', multi: true, name: 'job', query: 'label_values(up{job="integrations/agent"}, job)', refresh: 2, sort: 1, type: 'query' }, + }, + testInstanceSelector: { + actual: raw[2], + expect: { allValue: '.+', datasource: { type: 'prometheus', uid: '${datasource}' }, includeAll: false, label: 'Instance', multi: false, name: 'instance', query: 'label_values(up{job="integrations/agent",job=~"$job"}, instance)', refresh: 2, sort: 1, type: 'query' }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables_adhoc.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables_adhoc.libsonnet new file mode 100644 index 0000000..29e5e6e --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_variables_adhoc.libsonnet @@ -0,0 +1,65 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local jsonSignals = + { + datasource: 'custom_datasource', + datasourceLabel: 'Custom datasource', + aggLevel: 'group', + groupLabels: ['job'], + instanceLabels: ['instance'], + filteringSelector: 'job="integrations/agent"', + discoveryMetric: 'up2', + varAdHocEnabled: true, + varAdHocLabels: ['env', 'zone'], + signals: { + abc: { + name: 'ABC', + type: 'gauge', + description: 'ABC', + unit: 's', + expr: 'abc{%(queriesSelector)s}', + }, + }, + }; + +local signals = signal.unmarshallJson(jsonSignals); + +{ + multiChoice: { + local raw = signals.getVariablesMultiChoice(), + testResult: test.suite({ + testAdhocMulti: { + actual: raw[3], + expect: + { + datasource: + { type: 'prometheus', uid: '${custom_datasource}' }, + defaultKeys: + [{ text: 'env', value: 'env' }, { text: 'zone', value: 'zone' }], + description: 'Add additional filters', + label: 'Ad hoc filters', + name: 'adhoc', + type: 'adhoc', + }, + }, + }), + }, + singleChoice: { + local raw = signals.getVariablesSingleChoice(), + testResult: test.suite({ + testAdhocSingle: { + actual: raw[3], + expect: { + datasource: { type: 'prometheus', uid: '${custom_datasource}' }, + defaultKeys: [{ text: 'env', value: 'env' }, { text: 'zone', value: 'zone' }], + description: 'Add additional filters', + label: 'Ad hoc filters', + name: 'adhoc', + type: 'adhoc', + }, + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_exprWrappersMixin.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_exprWrappersMixin.libsonnet new file mode 100644 index 0000000..8c09d84 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_exprWrappersMixin.libsonnet @@ -0,0 +1,43 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.withExprWrappersMixin(['sum(', ')']).asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'sum(\n max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)\n)', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_filteringSelectorMixin.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_filteringSelectorMixin.libsonnet new file mode 100644 index 0000000..3e0a37d --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_filteringSelectorMixin.libsonnet @@ -0,0 +1,43 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.withFilteringSelectorMixin('environment="prod"').asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance",environment="prod"}[5m])\n)', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_offset.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_offset.libsonnet new file mode 100644 index 0000000..789d6c7 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_offset.libsonnet @@ -0,0 +1,43 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.withOffset('10m').asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'max by (job,instance) (\n rate((apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"} offset 10m)[5m])\n)', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_topk.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_topk.libsonnet new file mode 100644 index 0000000..67db780 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/test_with_topk.libsonnet @@ -0,0 +1,43 @@ +local signal = import './signal.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local m1 = signal.init( + filteringSelector=['job="abc"'], + interval='5m', + aggLevel='instance', + aggFunction='max', +).addSignal( + name='API server requests', + nameShort='requests', + type='counter', + unit='requests', + description='API server calls.', + sourceMaps=[ + { + expr: 'apiserver_request_total{%(queriesSelector)s}', + rangeFunction: 'rate', + aggKeepLabels: [], + legendCustomTemplate: null, + infoLabel: null, + }, + ], +) +; + +{ + + asTarget: { + local raw = m1.withTopK(10).asTarget(), + testResult: test.suite({ + testLegend: { + actual: raw.legendFormat, + expect: '{{instance}}: requests', + }, + testExpression: { + actual: raw.expr, + expect: 'topk(10,\n max by (job,instance) (\n rate(apiserver_request_total{job="abc",job=~"$job",instance=~"$instance"}[5m])\n)\n)', + }, + }), + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/utils.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/utils.libsonnet new file mode 100644 index 0000000..5383640 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/signal/utils.libsonnet @@ -0,0 +1,61 @@ +{ + wrapExpr(type, expr, exprWrappers=[], q=0.95, aggLevel, rangeFunction, alertRule): { + + // additional templates to wrap base expression + functionTemplates:: + ( + if aggLevel != 'none' && (type == 'counter' || type == 'gauge' || type == 'info') + then + [ + ['%(aggFunction)s by (%(agg)s) (', ')'], + ] + else [] + ) + + exprWrappers, + + withFuncTemplate(funcTemplate):: self { + functionTemplates+: [funcTemplate], + }, + runTemplate(expr, funcTemplate):: funcTemplate[0] + '\n ' + expr + '\n' + funcTemplate[1], + applyFunctions():: std.foldl(self.runTemplate, self.functionTemplates, self.expr), + + expr: if type == 'counter' then + ( + // for increase/delta/idelta - must be $__interval with negative offset for proper Total calculations, else use default from init function. + local interval = + if (rangeFunction == 'idelta' || rangeFunction == 'delta' || rangeFunction == 'increase') then + (if alertRule then '[%(interval)s:] offset -%(interval)s' else '[$__interval:] offset -$__interval') + else '[%(interval)s]'; + local baseExpr = rangeFunction + '(' + expr + interval + ')'; + baseExpr + ) + else if type == 'gauge' then + ( + expr + ) + else if type == 'histogram' then + ( + local baseExpr = 'histogram_quantile(' + '%.2f' % q + ', sum(' + rangeFunction + '(' + expr + '[%(interval)s])) by (le,%(agg)s))'; + baseExpr + ) + else expr, + }, + + + wrapLegend(legend, aggLevel, legendCustomTemplate): + if legendCustomTemplate != null then legendCustomTemplate + else + '%(aggLegend)s: ' + legend, + + generateUnits(type, unit, rangeFunction): + if type == 'counter' && (rangeFunction == 'rate' || rangeFunction == 'irate') then + ( + // some specific cases + if unit == 'seconds' || unit == 's' then 'percent' + else if unit == 'requests' then 'rps' + else if unit == 'packets' then 'pps' + else unit + ) + else unit, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/utils.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/utils.libsonnet new file mode 100644 index 0000000..0272dd9 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/utils.libsonnet @@ -0,0 +1,43 @@ +{ + local this = self, + + labelsToURLvars(labels, prefix):: + std.join('&', ['var-%s=${%s%s}' % [label, prefix, label] for label in labels]), + + // For PromQL or LogQL + labelsToPromQLSelector(labels): std.join(',', ['%s=~"$%s"' % [label, label] for label in labels]), + labelsToLogQLSelector: self.labelsToPromQLSelector, + labelsToPromQLSelectorAdvanced(labels): std.join(',', ['%s=~"${%s:regex}"' % [label, label] for label in labels]), + labelsToLogQLSelectorAdvanced: self.labelsToPromQLSelectorAdvanced, + + labelsToPanelLegend(labels, separator='/'): std.join(separator, ['{{%s}}' % [label] for label in labels]), + + toSentenceCase(string):: + std.asciiUpper(string[0]) + std.slice(string, 1, std.length(string), 1), + + // Generate a chain of labels. Useful to create chained variables: + chainLabels(labels, additionalFilters=[]): + local last(arr) = std.reverse(arr)[0]; + local chainSelector(chain) = + std.join( + ',', + additionalFilters + + (if std.length(chain) > 0 + then [this.labelsToPromQLSelector(chain)] + else []) + ); + std.foldl( + function(prev, label) + prev + + [{ + label: label, + chainSelector: chainSelector(self.chain), + chain:: + if std.length(prev) > 0 + then last(prev).chain + [last(prev).label] + else [], + }], + labels, + [] + ), +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/variables/variables.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/variables/variables.libsonnet new file mode 100644 index 0000000..fa56752 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/common/variables/variables.libsonnet @@ -0,0 +1,140 @@ +local g = import '../g.libsonnet'; +local var = g.dashboard.variable; +local utils = import '../utils.libsonnet'; + +{ + new( + filteringSelector, + groupLabels, + instanceLabels, + varMetric='up', + enableLokiLogs=false, + customAllValue='.+', + prometheusDatasourceName=if enableLokiLogs then 'prometheus_datasource' else 'datasource', + prometheusDatasourceLabel=if enableLokiLogs then 'Prometheus data source' else 'Data source', + adHocEnabled=false, + adHocLabels=[], + ): { + // strip trailing or starting comma if present: + // while trailing comma is accepted in PromQL expressions, starting comma is not. + // starting comma can be present in case of concatenation of empty filteringSelector with some extra selectors. + local _filteringSelector = std.stripChars(std.stripChars(filteringSelector, ' '), ','), + + local varMetricTemplate(varMetric, chainSelector) = + // check if chainSelector is not empty string (case when filtering selector is empty): + if std.type(varMetric) == 'array' && chainSelector != '' + then '{__name__=~"%s",%s}' % [std.join('|', std.uniq(varMetric)), chainSelector] + else if std.type(varMetric) == 'array' && chainSelector == '' + then '{__name__=~"%s"}' % std.join('|', std.uniq(varMetric)) + else if std.type(varMetric) == 'string' + then '%s{%s}' % [varMetric, chainSelector] + else error ('varMetric must be array or string'), + + local root = self, + local variablesFromLabels(groupLabels, instanceLabels, filteringSelector, multiInstance=true) = + local chainVarProto(index, chainVar) = + var.query.new(chainVar.label) + + var.query.withDatasourceFromVariable(root.datasources.prometheus) + + var.query.queryTypes.withLabelValues( + chainVar.label, + varMetricTemplate(varMetric, chainVar.chainSelector), + ) + + var.query.generalOptions.withLabel(utils.toSentenceCase(chainVar.label)) + + var.query.selectionOptions.withIncludeAll( + value=if (!multiInstance && std.member(instanceLabels, chainVar.label)) then false else true, + customAllValue=customAllValue, + ) + + var.query.selectionOptions.withMulti( + if (!multiInstance && std.member(instanceLabels, chainVar.label)) then false else true, + ) + + var.query.refresh.onTime() + + var.query.withSort( + i=1, + type='alphabetical', + asc=true, + caseInsensitive=false + ); + std.mapWithIndex(chainVarProto, utils.chainLabels(groupLabels + instanceLabels, if std.length(filteringSelector) > 0 then [filteringSelector] else [])), + datasources: { + prometheus: + var.datasource.new(prometheusDatasourceName, 'prometheus') + + var.datasource.generalOptions.withLabel(prometheusDatasourceLabel) + + var.datasource.withRegex(''), + }, + adHoc: + var.adhoc.new('adhoc', 'prometheus', '${' + root.datasources.prometheus.name + '}') + + var.adhoc.generalOptions.withLabel('Ad hoc filters') + + var.adhoc.generalOptions.withDescription('Add additional filters') + + (if std.length(adHocLabels) > 0 then { + defaultKeys: [ + { + text: l, + value: l, + } + for l in adHocLabels + ], + } else {}), + + // Use on dashboards where multiple entities can be selected, like fleet dashboards + multiInstance: + [root.datasources.prometheus] + + variablesFromLabels(groupLabels, instanceLabels, _filteringSelector) + + (if adHocEnabled then [self.adHoc] else []), + // Use on dashboards where only single entity can be selected + singleInstance: + [root.datasources.prometheus] + + variablesFromLabels(groupLabels, instanceLabels, _filteringSelector, multiInstance=false) + + (if adHocEnabled then [self.adHoc] else []), + queriesSelectorAdvancedSyntax: + std.join( + ',', + std.filter(function(x) std.length(x) > 0, [ + _filteringSelector, + utils.labelsToPromQLSelectorAdvanced(groupLabels + instanceLabels), + ]) + ), + queriesSelector: + std.join( + ',', + std.filter(function(x) std.length(x) > 0, [ + _filteringSelector, + utils.labelsToPromQLSelector(groupLabels + instanceLabels), + ]) + ), + queriesSelectorGroupOnly: + std.join( + ',', + std.filter(function(x) std.length(x) > 0, [ + _filteringSelector, + utils.labelsToPromQLSelector(groupLabels), + ]) + ), + queriesSelectorFilterOnly: + std.join( + ',', + std.filter(function(x) std.length(x) > 0, [ + _filteringSelector, + '', + ]) + ), + + } + + if enableLokiLogs then self.withLokiLogs() else {}, + + withLokiLogs( + lokiDatasourceName='loki_datasource', + lokiDatasourceLabel='Loki data source', + ): { + datasources+: { + loki: + var.datasource.new(lokiDatasourceName, 'loki') + + var.datasource.generalOptions.withLabel(lokiDatasourceLabel) + + var.datasource.withRegex('') + + var.datasource.generalOptions.showOnDashboard.withNothing(), + }, + + multiInstance+: [self.datasources.loki], + singleInstance+: [self.datasources.loki], + }, + +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/jsonnetfile.json b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/jsonnetfile.json new file mode 100644 index 0000000..3e0ec40 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/common-lib/jsonnetfile.json @@ -0,0 +1,24 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-v11.0.0" + } + }, + "version": "main" + }, + { + "source": { + "git": { + "remote": "https://github.com/yugui/jsonnetunit.git", + "subdir": "jsonnetunit" + } + }, + "version": "master" + } + ], + "legacyImports": true +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/README.md b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/README.md new file mode 100644 index 0000000..7c3da2b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/README.md @@ -0,0 +1,3 @@ +# Grafana Cloud Integration Utilities + +This is a library of useful utility functions for the mixins deployed on Grafana Cloud as [Integrations](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/integrations/). \ No newline at end of file diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/jsonnetfile.json b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/jsonnetfile.json new file mode 100644 index 0000000..95d705f --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/jsonnetfile.json @@ -0,0 +1,33 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet-lib.git", + "subdir": "grafonnet" + } + }, + "version": "master" + }, + { + "source": { + "git": { + "remote": "https://github.com/grafana/grafonnet.git", + "subdir": "gen/grafonnet-latest" + } + }, + "version": "main" + }, + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/xtd.git", + "subdir": "" + } + }, + "version": "master" + } + ], + "legacyImports": true +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/main.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/main.libsonnet new file mode 100644 index 0000000..89fbb0b --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/main.libsonnet @@ -0,0 +1,4 @@ +(import './util.libsonnet') + +{ + dashboards: import './util-dashboards.libsonnet', +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util-dashboards.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util-dashboards.libsonnet new file mode 100644 index 0000000..2b84ff3 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util-dashboards.libsonnet @@ -0,0 +1,239 @@ +{ + overview_dashboard( + title, + uid, + logoURL, + seriesSelector='__name__ =~ ".+"', + type='prometheus', + dropdownLabel='Instance', + dropdownSelector='instance', + dropdownAllValueSelector='.+', + unit='pps', + query='count by (__name__) ({%s, instance=~"$instance", job=~"$job"})', + drawStyle='line', + description='Shows the number of samples received by metric name received for this integration.', + legendFormat='__auto', + jobLabel='Job', + jobSelector=seriesSelector, + allValueJob='.+' + ):: + { + editable: true, + fiscalYearStartMonth: 0, + graphTooltip: 0, + links: [], + liveNow: false, + panels: [ + { + gridPos: { + h: 12, + w: 7, + x: 0, + y: 0, + }, + id: 1, + options: { + mode: 'markdown', + code: { + language: 'plaintext', + showLineNumbers: false, + showMiniMap: false, + }, + content: std.format('
', logoURL), + }, + pluginVersion: '9.4.3', + title: 'Logo', + type: 'text', + }, + { + type: 'timeseries', + title: 'Samples Received', + datasource: { + uid: '$datasource', + type: type, + }, + gridPos: { + x: 7, + y: 0, + w: 17, + h: 12, + }, + id: 7, + targets: [ + { + datasource: { + type: type, + uid: '$datasource', + }, + refId: 'A', + editorMode: 'code', + expr: std.format(query, seriesSelector), + legendFormat: legendFormat, + range: true, + }, + ], + options: { + tooltip: { + mode: 'single', + sort: 'none', + }, + legend: { + showLegend: true, + displayMode: 'list', + placement: 'bottom', + calcs: [], + }, + }, + fieldConfig: { + defaults: { + custom: { + drawStyle: drawStyle, + lineInterpolation: 'linear', + barAlignment: 0, + lineWidth: 1, + fillOpacity: 0, + gradientMode: 'none', + spanNulls: false, + showPoints: 'auto', + pointSize: 5, + stacking: { + mode: 'none', + group: 'A', + }, + axisPlacement: 'auto', + axisLabel: '', + axisColorMode: 'text', + scaleDistribution: { + type: 'linear', + }, + axisCenteredZero: false, + hideFrom: { + tooltip: false, + viz: false, + legend: false, + }, + thresholdsStyle: { + mode: 'off', + }, + lineStyle: { + fill: 'solid', + }, + }, + color: { + mode: 'palette-classic', + }, + mappings: [], + thresholds: { + mode: 'absolute', + steps: [ + { + value: null, + color: 'green', + }, + { + value: 80, + color: 'red', + }, + ], + }, + unit: unit, + }, + overrides: [], + }, + description: description, + }, + ], + refresh: '', + revision: 1, + schemaVersion: 38, + style: 'dark', + tags: [], + templating: { + list: [ + { + current: { + selected: false, + text: 'default', + value: 'default', + }, + hide: 0, + includeAll: false, + label: 'Data source', + multi: false, + name: 'datasource', + options: [], + query: type, + queryValue: '', + refresh: 1, + regex: '(?!grafanacloud-usage|grafanacloud-ml-metrics).+', + skipUrlSync: false, + type: 'datasource', + }, + { + allValue: dropdownAllValueSelector, + current: { + text: 'All', + value: [ + '$__all', + ], + }, + datasource: '$datasource', + definition: std.format('label_values({%s}, %s)', [seriesSelector, dropdownSelector]), + hide: 0, + includeAll: true, + label: dropdownLabel, + multi: true, + name: dropdownSelector, + options: [], + query: std.format('label_values({%s}, %s)', [seriesSelector, dropdownSelector]), + refresh: 1, + regex: '', + skipUrlSync: false, + sort: 0, + tagValuesQuery: '', + tags: [], + tagsQuery: '', + type: 'query', + useTags: false, + }, + { + allValue: allValueJob, + current: { + text: 'All', + value: [ + '$__all', + ], + }, + datasource: '$datasource', + definition: std.format('label_values({%s}, job)', jobSelector), + hide: 0, + includeAll: true, + label: jobLabel, + multi: true, + name: 'job', + options: [], + query: std.format('label_values({%s}, job)', jobSelector), + refresh: 1, + regex: '', + skipUrlSync: false, + sort: 0, + tagValuesQuery: '', + tags: [], + tagsQuery: '', + type: 'query', + useTags: false, + }, + ], + }, + time: { + from: 'now-6h', + to: 'now', + }, + timepicker: {}, + timezone: '', + title: title, + version: 1, + weekStart: '', + uid: uid, + }, +} diff --git a/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util.libsonnet b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util.libsonnet new file mode 100644 index 0000000..9224ef8 --- /dev/null +++ b/mixin/vendor/github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils/util.libsonnet @@ -0,0 +1,500 @@ +local g = import 'grafonnet-latest/main.libsonnet'; +local grafana = (import 'grafonnet/grafana.libsonnet'); +local statusPanels = import 'status-panels-lib/status-panels/main.libsonnet'; +local xtd = import 'xtd/main.libsonnet'; +local var = g.dashboard.variable; + +local debug(obj) = + std.trace(std.toString(obj), obj); + +local notNull(i) = i != null; +local flatten(acc, i) = acc + i; +local join(a) = std.foldl(flatten, std.filter(notNull, a), []); + +local setGridPos(h, w, x, y) = { + gridPos: { + h: h, + w: w, + x: x, + y: y, + }, +}; + +// Required for jsonnet dashboards with older schema +local setSpan(w) = { + span: w / 2, +}; + +local integration_status_row_internal(height, width, xPos, yPos) = + grafana.row.new(title='Integration Status') + + setGridPos(height, width, xPos, yPos) + + setSpan(width); + +local integration_status_panel(statusPanelQuery, statusPanelDataSource, height, width, xPos, yPos, setId) = + grafana.statPanel.new( + 'Integration Status', + description='Shows the status of the integration.', + datasource=statusPanelDataSource, + unit='string', + colorMode='background', + graphMode='none', + noValue='No Data', + reducerFunction='lastNotNull', + timeFrom='now/d', + ) + .addMappings( + [ + { + options: { + from: 1, + result: { + color: 'green', + index: 0, + text: 'Receiving Metrics', + }, + to: 10000000000000, + }, + type: 'range', + }, + { + options: { + from: 0, + result: { + color: 'red', + index: 1, + text: 'No Data', + }, + to: 0, + }, + type: 'range', + }, + ] + ) + .addTarget( + grafana.prometheus.target( + statusPanelQuery, + instant=true + ) + ) + + setGridPos(height, width, xPos, yPos) + + setSpan(width) + (if setId then { + id: 1001, + } else {}); + +local latest_metric_panel(statusPanelQuery, statusPanelDataSource, height, width, xPos, yPos, setId) = + grafana.statPanel.new( + 'Latest Metric Received', + description='Shows the latest timestamp at which the metrics were received for this integration.', + datasource=statusPanelDataSource, + unit='dateTimeAsIso', + colorMode='background', + fields='Time', + graphMode='none', + noValue='No Data', + reducerFunction='lastNotNull', + timeFrom='now/d', + ) + .addTarget( + grafana.prometheus.target(statusPanelQuery) + ) + + setGridPos(height, width, xPos, yPos) + + setSpan(width) + (if setId then { + id: 1002, + } else {}); + +local integration_version_panel(version, statusPanelDataSource, height, width, xPos, yPos, setId) = + grafana.statPanel.new( + 'Integration Version', + description='Shows the installed version of this integration.', + unit='string', + datasource=statusPanelDataSource, + noValue=version, + ) + + setGridPos(height, width, xPos, yPos) + + setSpan(width) + (if setId then { + id: 1003, + } else {}); + +{ + decorate_dashboard(dashboard, tags, refresh='30s', timeFrom='now-30m'):: + dashboard { + editable: false, + id: null, // If id is set the grafana client will try to update instead of create + tags: tags, + refresh: refresh, + time: { + from: timeFrom, + to: 'now', + }, + templating: { + list+: [ + if t.type == 'datasource' then + if t.query == 'prometheus' then + t { regex: '(?!grafanacloud-usage|grafanacloud-ml-metrics).+' } + else if t.query == 'loki' then + t { regex: '(?!grafanacloud.+usage-insights|grafanacloud.+alert-state-history).+' } + else t + else if t.type == 'query' then + t { refresh: 2 } + else t + for t in dashboard.templating.list + ], + }, + }, + + // This function can be used to patch dashboards variables, matching by name: + // patch format: + // { + // cluster: { + // allValues: ".*" + // }, + // } + patch_variables(dashboard, patch):: + { + templating: { + list+: [ + t + std.get(patch, t.name, default={}) + for t in dashboard.templating.list + ], + }, + }, + + // This function can be used to patch alert rules: + // prometheusAlerts format (as in mixin): + // { + // groups: [ + // { + // name: 'abc', + // rules: [ + // { + // alert: 'Alert1', + // expr: 'up==0', + // labels: { + // severity: "warning" + // } + // }, + // { + // alert: 'Alert2', + // expr: 'up!=0', + // labels: { + // severity: "warning" + // } + // }, + // ] + // } + // ] + // } + // patch format: + // { + // Alert1: { + // labels+: { + // new_label: 'abc', + // asserts_severity: super.severity, + // } + // }, + // Alert2: { + // labels+: { + // new_label: 'zyx', + // } + // } + // } + patch_alerts(prometheusAlerts, group_name, alert_rules_patch):: + local patch_rules(rules, patch) = + [ + if std.objectHasAll(patch, rule.alert) then + rule + patch[rule.alert] + else rule + for rule + in rules + ]; + { + groups+: + [ + if group.name == group_name then + { + name: group_name, + rules: patch_rules(group.rules, alert_rules_patch), + } + else group + for group in prometheusAlerts.groups + + ], + }, + + // Adds asserts specific variables to the dashboards + add_asserts_variables(dashboard, config, hidden=true):: + local ds_name = + std.prune([ + if std.objectHas(template, 'type') && template.type == 'datasource' && template.query == 'prometheus' + then + std.get(template, 'name') + else null + for template in dashboard.templating.list + ])[0]; + dashboard + { + templating: { + list: [ + var.query.new('env') + + var.query.withDatasource('prometheus', '${%s}' % ds_name) + + var.query.queryTypes.withLabelValues( + 'asserts_env', + 'asserts:mixin_workload_job', + ) + + var.query.generalOptions.withLabel('Asserts environment') + + ( + if hidden then var.query.generalOptions.showOnDashboard.withNothing() else var.query.generalOptions.showOnDashboard.withLabelAndValue() + ) + + var.query.selectionOptions.withIncludeAll( + value=true, + customAllValue='.*' + ) + + var.query.selectionOptions.withMulti( + false + ) + + var.query.refresh.onTime() + + var.query.withSort( + i=1, + type='alphabetical', + asc=true, + caseInsensitive=false + ), + var.query.new('site') + + var.query.withDatasource('prometheus', '${%s}' % ds_name) + + var.query.queryTypes.withLabelValues( + 'asserts_site', + 'asserts:mixin_workload_job{asserts_env=~"$env"}', + ) + + var.query.generalOptions.withLabel('Asserts site') + + ( + if hidden then var.query.generalOptions.showOnDashboard.withNothing() else var.query.generalOptions.showOnDashboard.withLabelAndValue() + ) + + var.query.selectionOptions.withIncludeAll( + value=true, + customAllValue='.*' + ) + + var.query.selectionOptions.withMulti( + false + ) + + var.query.refresh.onTime() + + var.query.withSort( + i=1, + type='alphabetical', + asc=true, + caseInsensitive=false + ), + ] + dashboard.templating.list, + }, + panels: if std.objectHas(dashboard, 'panels') && std.isArray(dashboard.panels) && std.length(dashboard.panels) > 0 then [ + if std.objectHas(panel, 'targets') then + panel { + targets: [ + if std.objectHas(target, 'expr') then + target { + expr: local temp = std.strReplace(target.expr, '${', '___DOLLAR_BRACE___'); + local replaced = std.strReplace(temp, '{', '{asserts_env=~"$env", asserts_site=~"$site", '); + std.strReplace(replaced, '___DOLLAR_BRACE___', '${'), + } + else target + for target in panel.targets + ], + } else panel + for panel in dashboard.panels + ] else [], + + rows: if std.objectHas(dashboard, 'rows') && std.isArray(dashboard.rows) && std.length(dashboard.rows) > 0 then [ + row { + panels: [ + if std.objectHas(panel, 'targets') then + panel { + targets: [ + if std.objectHas(target, 'expr') then + target { + expr: local temp = std.strReplace(target.expr, '${', '___DOLLAR_BRACE___'); + local replaced = std.strReplace(temp, '{', '{asserts_env=~"$env", asserts_site=~"$site", '); + std.strReplace(replaced, '___DOLLAR_BRACE___', '${'), + } + else target + for target in panel.targets + ], + } + else panel + for panel in row.panels + ], + } + for row in dashboard.rows + ] else [], + }, + + prepare_dashboards(dashboards, tags, folderName, ignoreDashboards=[], refresh='30s', timeFrom='now-30m'):: { + [k]: { + dashboard: $.decorate_dashboard(dashboards[k], tags, refresh, timeFrom), + folderId: 0, + overwrite: true, + folderName: folderName, + } + for k in std.objectFields(dashboards) + if !std.member(ignoreDashboards, k) + }, + prepare_alerts(namespace, prometheusAlerts, ignoreAlerts=[], ignoreAlertGroups=[], extraAnnotations={}, extraLabels={}):: + { + namespace: namespace, + } + + prometheusAlerts + { + groups: + std.map(function(el) el { + rules: + std.map(function(r) r { + annotations+: extraAnnotations, + labels+: extraLabels, + }, + std.filter( + function(r) !std.member(ignoreAlerts, r.alert), + super.rules + )), + }, std.filter(function(g) !std.member(ignoreAlertGroups, g.name), super.groups)), + }, + prepare_rules(namespace, rules, ignoreRules=[], ignoreRuleGroups=[], extraAnnotations={}, extraLabels={}):: + { + namespace: namespace, + } + + rules + { + groups: + std.map(function(rr) rr { + rules: + std.map(function(r) r { + annotations+: extraAnnotations, + labels+: extraLabels, + }, + std.filter( + function(r) !std.member(ignoreRules, r.record), + super.rules + )), + }, std.filter(function(g) !std.member(ignoreRuleGroups, g.name), super.groups)), + }, + integration_status_panels(config, version, setId):: + [ + integration_status_panel( + config.statusPanelQuery, + config.statusPanelDataSource, + config.statusPanelGridPos[0], + config.statusPanelGridPos[1], + config.statusPanelGridPos[2], + config.statusPanelGridPos[3], + setId, + ), + latest_metric_panel( + config.statusPanelQuery, + config.statusPanelDataSource, + config.statusPanelGridPos[0], + config.statusPanelGridPos[1], + config.statusPanelGridPos[2] + 1 * config.statusPanelGridPos[1], + config.statusPanelGridPos[3], + setId, + ), + integration_version_panel( + version, + config.statusPanelDataSource, + config.statusPanelGridPos[0], + config.statusPanelGridPos[1], + config.statusPanelGridPos[2] + 2 * config.statusPanelGridPos[1], + config.statusPanelGridPos[3], + setId, + ), + ], + integration_status_row(dashboard, config, version):: + if std.isArray(dashboard.panels) && std.length(dashboard.panels) > 0 then + { + panels: [ + integration_status_row_internal( + config.statusPanelGridPos[0], + config.statusPanelGridPos[1], + config.statusPanelGridPos[2], + config.statusPanelGridPos[3], + ), + ] + + $.integration_status_panels(config, version, false) + + [ + panel { + gridPos: { + h: panel.gridPos.h, + w: panel.gridPos.w, + x: panel.gridPos.x, + y: panel.gridPos.y + config.statusPanelGridPos[0], + }, + } + for panel in dashboard.panels + ], + } + else + { + rows: [ + integration_status_row_internal( + config.statusPanelGridPos[0], + config.statusPanelGridPos[1], + config.statusPanelGridPos[2], + config.statusPanelGridPos[3], + ) + { + panels: $.integration_status_panels(config, version, true), + }, + ] + dashboard.rows, + }, + add_status_panels(dashboard, config, version):: + if std.member(config.statusPanelDashboards, dashboard.title) then + $.integration_status_row(dashboard, config, version) + else {}, + integration_status_row_lib(type, dashboard, config):: + if std.isArray(dashboard.panels) && std.length(dashboard.panels) > 0 then + { + panels: join( + [ + (statusPanels.new( + 'Integration Status', + type=type, + statusPanelsQueryMetrics=config.statusPanelsQueryMetrics, + datasourceNameMetrics=config.statusPanelsDatasourceNameMetrics, + statusPanelsQueryLogs=config.statusPanelsQueryLogs, + datasourceNameLogs=config.statusPanelsDatasourceNameLogs, + showIntegrationVersion=true, + integrationVersion=config.statusPanelsIntegrationVersion, + panelsHeight=config.statusPanelsGridPos[0], + panelsWidth=config.statusPanelsGridPos[1], + rowPositionY=config.statusPanelsGridPos[3], + withRow=(if std.objectHas(config, 'statusPanelsWithRow') then config.statusPanelsWithRow else true), + )).panels.statusPanels, + [ + panel { + gridPos+: { + y: if std.objectHas(panel, 'gridPos') && std.objectHas(panel.gridPos, 'y') then + panel.gridPos.y + config.statusPanelsGridPos[0] + 1 + else config.statusPanelsGridPos[0] + 1, + }, + } + for panel in dashboard.panels + ], + ] + ), + } + else + { + rows: dashboard.rows, + }, + add_status_panels_lib(dashboard, config):: + if std.member(config.statusPanelsDashboardsMetrics, dashboard.title) then + $.integration_status_row_lib('metrics', dashboard, config) + else if std.member(config.statusPanelsDashboardsLogs, dashboard.title) then + $.integration_status_row_lib('logs', dashboard, config) + else if std.member(config.statusPanelsDashboardsBoth, dashboard.title) then + $.integration_status_row_lib('both', dashboard, config) + else {}, + + // adds links by integration tag. + add_links_by_tag(tags, title='Integration dashboards', asDropdown=false, includeVars=true):: { + links+: [ + g.dashboard.link.dashboards.new(title=title, tags=tags) + + g.dashboard.link.dashboards.options.withIncludeVars(includeVars) + + g.dashboard.link.dashboards.options.withKeepTime(true) + + g.dashboard.link.dashboards.options.withAsDropdown(asDropdown), + ], + }, +} diff --git a/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md new file mode 100644 index 0000000..c677742 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/README.md @@ -0,0 +1,326 @@ +# doc-util + +`doc-util` provides a Jsonnet interface for `docsonnet`, + a Jsonnet API doc generator that uses structured data instead of comments. + +## Install + +``` +jb install github.com/jsonnet-libs/docsonnet/doc-util@master +``` + +## Usage + +```jsonnet +local d = import "github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet" +``` + + +## Index + +* [`fn arg(name, type, default, enums)`](#fn-arg) +* [`fn fn(help, args)`](#fn-fn) +* [`fn obj(help, fields)`](#fn-obj) +* [`fn pkg(name, url, help, filename="", version="master")`](#fn-pkg) +* [`fn render(obj)`](#fn-render) +* [`fn val(type, help, default)`](#fn-val) +* [`obj argument`](#obj-argument) + * [`fn fromSchema(name, schema)`](#fn-argumentfromschema) + * [`fn new(name, type, default, enums)`](#fn-argumentnew) +* [`obj func`](#obj-func) + * [`fn new(help, args)`](#fn-funcnew) + * [`fn withArgs(args)`](#fn-funcwithargs) + * [`fn withHelp(help)`](#fn-funcwithhelp) +* [`obj object`](#obj-object) + * [`fn new(help, fields)`](#fn-objectnew) + * [`fn withFields(fields)`](#fn-objectwithfields) +* [`obj value`](#obj-value) + * [`fn new(type, help, default)`](#fn-valuenew) +* [`obj T`](#obj-t) +* [`obj package`](#obj-package) + * [`fn new(name, url, help, filename="", version="master")`](#fn-packagenew) + * [`fn newSub(name, help)`](#fn-packagenewsub) + +## Fields + +### fn arg + +```jsonnet +arg(name, type, default, enums) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **default** (`any`) +* **enums** (`array`) + +`arg` is a shorthand for `argument.new` +### fn fn + +```jsonnet +fn(help, args) +``` + +PARAMETERS: + +* **help** (`string`) +* **args** (`array`) + +`fn` is a shorthand for `func.new` +### fn obj + +```jsonnet +obj(help, fields) +``` + +PARAMETERS: + +* **help** (`string`) +* **fields** (`object`) + +`obj` is a shorthand for `object.new` +### fn pkg + +```jsonnet +pkg(name, url, help, filename="", version="master") +``` + +PARAMETERS: + +* **name** (`string`) +* **url** (`string`) +* **help** (`string`) +* **filename** (`string`) + - default value: `""` +* **version** (`string`) + - default value: `"master"` + +`new` is a shorthand for `package.new` +### fn render + +```jsonnet +render(obj) +``` + +PARAMETERS: + +* **obj** (`object`) + +`render` converts the docstrings to human readable Markdown files. + +Usage: + +```jsonnet +// docs.jsonnet +d.render(import 'main.libsonnet') +``` + +Call with: `jsonnet -S -c -m docs/ docs.jsonnet` + +### fn val + +```jsonnet +val(type, help, default) +``` + +PARAMETERS: + +* **type** (`string`) +* **help** (`string`) +* **default** (`any`) + +`val` is a shorthand for `value.new` +### obj argument + +Utilities for creating function arguments + +#### fn argument.fromSchema + +```jsonnet +argument.fromSchema(name, schema) +``` + +PARAMETERS: + +* **name** (`string`) +* **schema** (`object`) + +`fromSchema` creates a new function argument, taking a JSON `schema` to describe the type information for this argument. + +Examples: + +```jsonnet +[ + d.argument.fromSchema('foo', { type: 'string' }), + d.argument.fromSchema('bar', { type: 'string', default='loo' }), + d.argument.fromSchema('baz', { type: 'number', enum=[1,2,3] }), +] +``` + +#### fn argument.new + +```jsonnet +argument.new(name, type, default, enums) +``` + +PARAMETERS: + +* **name** (`string`) +* **type** (`string`) +* **default** (`any`) +* **enums** (`array`) + +`new` creates a new function argument, taking the `name`, the `type`. Optionally it +can take a `default` value and `enum`-erate potential values. + +Examples: + +```jsonnet +[ + d.argument.new('foo', d.T.string), + d.argument.new('bar', d.T.string, default='loo'), + d.argument.new('baz', d.T.number, enums=[1,2,3]), +] +``` + +### obj func + +Utilities for documenting Jsonnet methods (functions of objects) + +#### fn func.new + +```jsonnet +func.new(help, args) +``` + +PARAMETERS: + +* **help** (`string`) +* **args** (`array`) + +new creates a new function, optionally with description and arguments +#### fn func.withArgs + +```jsonnet +func.withArgs(args) +``` + +PARAMETERS: + +* **args** (`array`) + +The `withArgs` modifier overrides the arguments of that function +#### fn func.withHelp + +```jsonnet +func.withHelp(help) +``` + +PARAMETERS: + +* **help** (`string`) + +The `withHelp` modifier overrides the help text of that function +### obj object + +Utilities for documenting Jsonnet objects (`{ }`). + +#### fn object.new + +```jsonnet +object.new(help, fields) +``` + +PARAMETERS: + +* **help** (`string`) +* **fields** (`object`) + +new creates a new object, optionally with description and fields +#### fn object.withFields + +```jsonnet +object.withFields(fields) +``` + +PARAMETERS: + +* **fields** (`object`) + +The `withFields` modifier overrides the fields property of an already created object +### obj value + +Utilities for documenting plain Jsonnet values (primitives) + +#### fn value.new + +```jsonnet +value.new(type, help, default) +``` + +PARAMETERS: + +* **type** (`string`) +* **help** (`string`) +* **default** (`any`) + +new creates a new object of given type, optionally with description and default value +### obj T + +* `T.any` (`string`): `"any"` - argument of type "any" +* `T.array` (`string`): `"array"` - argument of type "array" +* `T.boolean` (`string`): `"bool"` - argument of type "boolean" +* `T.func` (`string`): `"function"` - argument of type "func" +* `T.null` (`string`): `"null"` - argument of type "null" +* `T.number` (`string`): `"number"` - argument of type "number" +* `T.object` (`string`): `"object"` - argument of type "object" +* `T.string` (`string`): `"string"` - argument of type "string" + +### obj package + + +#### fn package.new + +```jsonnet +package.new(name, url, help, filename="", version="master") +``` + +PARAMETERS: + +* **name** (`string`) +* **url** (`string`) +* **help** (`string`) +* **filename** (`string`) + - default value: `""` +* **version** (`string`) + - default value: `"master"` + +`new` creates a new package + +Arguments: + +* given `name` +* source `url` for jsonnet-bundler and the import +* `help` text +* `filename` for the import, defaults to blank for backward compatibility +* `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler + +#### fn package.newSub + +```jsonnet +package.newSub(name, help) +``` + +PARAMETERS: + +* **name** (`string`) +* **help** (`string`) + +`newSub` creates a package without the preconfigured install/usage templates. + +Arguments: + +* given `name` +* `help` text diff --git a/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet new file mode 100644 index 0000000..f3ec298 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet @@ -0,0 +1,263 @@ +{ + local d = self, + + '#': + d.pkg( + name='doc-util', + url='github.com/jsonnet-libs/docsonnet/doc-util', + help=||| + `doc-util` provides a Jsonnet interface for `docsonnet`, + a Jsonnet API doc generator that uses structured data instead of comments. + |||, + filename=std.thisFile, + ) + + d.package.withUsageTemplate( + 'local d = import "%(import)s"' + ), + + package:: { + '#new':: d.fn(||| + `new` creates a new package + + Arguments: + + * given `name` + * source `url` for jsonnet-bundler and the import + * `help` text + * `filename` for the import, defaults to blank for backward compatibility + * `version` for jsonnet-bundler install, defaults to `master` just like jsonnet-bundler + |||, [ + d.arg('name', d.T.string), + d.arg('url', d.T.string), + d.arg('help', d.T.string), + d.arg('filename', d.T.string, ''), + d.arg('version', d.T.string, 'master'), + ]), + new(name, url, help, filename='', version='master'):: + { + name: name, + help: + help + + std.get(self, 'installTemplate', '') % self + + std.get(self, 'usageTemplate', '') % self, + 'import': + if filename != '' + then url + '/' + filename + else url, + url: url, + filename: filename, + version: version, + + } + + self.withInstallTemplate( + 'jb install %(url)s@%(version)s' + ) + + self.withUsageTemplate( + 'local %(name)s = import "%(import)s"' + ), + + '#newSub':: d.fn(||| + `newSub` creates a package without the preconfigured install/usage templates. + + Arguments: + + * given `name` + * `help` text + |||, [ + d.arg('name', d.T.string), + d.arg('help', d.T.string), + ]), + newSub(name, help):: + { + name: name, + help: help, + }, + + withInstallTemplate(template):: { + installTemplate: + if template != null + then + ||| + + ## Install + + ``` + %s + ``` + ||| % template + else '', + }, + + withUsageTemplate(template):: { + usageTemplate: + if template != null + then + ||| + + ## Usage + + ```jsonnet + %s + ``` + ||| % template + else '', + }, + }, + + '#pkg':: self.package['#new'] + d.func.withHelp('`new` is a shorthand for `package.new`'), + pkg:: self.package.new, + + '#object': d.obj('Utilities for documenting Jsonnet objects (`{ }`).'), + object:: { + '#new': d.fn('new creates a new object, optionally with description and fields', [d.arg('help', d.T.string), d.arg('fields', d.T.object)]), + new(help='', fields={}):: { object: { + help: help, + fields: fields, + } }, + + '#withFields': d.fn('The `withFields` modifier overrides the fields property of an already created object', [d.arg('fields', d.T.object)]), + withFields(fields):: { object+: { + fields: fields, + } }, + }, + + '#obj': self.object['#new'] + d.func.withHelp('`obj` is a shorthand for `object.new`'), + obj:: self.object.new, + + '#func': d.obj('Utilities for documenting Jsonnet methods (functions of objects)'), + func:: { + '#new': d.fn('new creates a new function, optionally with description and arguments', [d.arg('help', d.T.string), d.arg('args', d.T.array)]), + new(help='', args=[]):: { 'function': { + help: help, + args: args, + } }, + + '#withHelp': d.fn('The `withHelp` modifier overrides the help text of that function', [d.arg('help', d.T.string)]), + withHelp(help):: { 'function'+: { + help: help, + } }, + + '#withArgs': d.fn('The `withArgs` modifier overrides the arguments of that function', [d.arg('args', d.T.array)]), + withArgs(args):: { 'function'+: { + args: args, + } }, + }, + + '#fn': self.func['#new'] + d.func.withHelp('`fn` is a shorthand for `func.new`'), + fn:: self.func.new, + + '#argument': d.obj('Utilities for creating function arguments'), + argument:: { + '#new': d.fn(||| + `new` creates a new function argument, taking the `name`, the `type`. Optionally it + can take a `default` value and `enum`-erate potential values. + + Examples: + + ```jsonnet + [ + d.argument.new('foo', d.T.string), + d.argument.new('bar', d.T.string, default='loo'), + d.argument.new('baz', d.T.number, enums=[1,2,3]), + ] + ``` + |||, [ + d.arg('name', d.T.string), + d.arg('type', d.T.string), + d.arg('default', d.T.any), + d.arg('enums', d.T.array), + ]), + new(name, type, default=null, enums=null): { + name: name, + type: type, + default: default, + enums: enums, + }, + '#fromSchema': d.fn(||| + `fromSchema` creates a new function argument, taking a JSON `schema` to describe the type information for this argument. + + Examples: + + ```jsonnet + [ + d.argument.fromSchema('foo', { type: 'string' }), + d.argument.fromSchema('bar', { type: 'string', default='loo' }), + d.argument.fromSchema('baz', { type: 'number', enum=[1,2,3] }), + ] + ``` + |||, [ + d.arg('name', d.T.string), + d.arg('schema', d.T.object), + ]), + fromSchema(name, schema): { + name: name, + schema: schema, + }, + }, + '#arg': self.argument['#new'] + self.func.withHelp('`arg` is a shorthand for `argument.new`'), + arg:: self.argument.new, + + '#value': d.obj('Utilities for documenting plain Jsonnet values (primitives)'), + value:: { + '#new': d.fn('new creates a new object of given type, optionally with description and default value', [d.arg('type', d.T.string), d.arg('help', d.T.string), d.arg('default', d.T.any)]), + new(type, help='', default=null): { value: { + help: help, + type: type, + default: default, + } }, + }, + '#val': self.value['#new'] + self.func.withHelp('`val` is a shorthand for `value.new`'), + val:: self.value.new, + + // T contains constants for the Jsonnet types + T:: { + '#string': d.val(d.T.string, 'argument of type "string"'), + string: 'string', + + '#number': d.val(d.T.string, 'argument of type "number"'), + number: 'number', + int: self.number, + integer: self.number, + + '#boolean': d.val(d.T.string, 'argument of type "boolean"'), + boolean: 'bool', + bool: self.boolean, + + '#object': d.val(d.T.string, 'argument of type "object"'), + object: 'object', + + '#array': d.val(d.T.string, 'argument of type "array"'), + array: 'array', + + '#any': d.val(d.T.string, 'argument of type "any"'), + any: 'any', + + '#null': d.val(d.T.string, 'argument of type "null"'), + 'null': 'null', + nil: self['null'], + + '#func': d.val(d.T.string, 'argument of type "func"'), + func: 'function', + 'function': self.func, + }, + + '#render': d.fn( + ||| + `render` converts the docstrings to human readable Markdown files. + + Usage: + + ```jsonnet + // docs.jsonnet + d.render(import 'main.libsonnet') + ``` + + Call with: `jsonnet -S -c -m docs/ docs.jsonnet` + |||, + args=[ + d.arg('obj', d.T.object), + ] + ), + render:: (import './render.libsonnet').render, + +} diff --git a/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet new file mode 100644 index 0000000..758b033 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/docsonnet/doc-util/render.libsonnet @@ -0,0 +1,479 @@ +{ + local root = self, + + render(obj): + assert std.isObject(obj) && '#' in obj : 'error: object is not a docsonnet package'; + local package = self.package(obj); + package.toFiles(), + + findPackages(obj, path=[]): { + local find(obj, path, parentWasPackage=true) = + std.foldl( + function(acc, k) + acc + + ( + // If matches a package but warn if also has an object docstring + if '#' in obj[k] && '#' + k in obj + && !std.objectHasAll(obj[k]['#'], 'ignore') + then std.trace( + 'warning: %s both defined as object and package' % k, + [root.package(obj[k], path + [k], parentWasPackage)] + ) + // If matches a package, return it + else if '#' in obj[k] + && !std.objectHasAll(obj[k]['#'], 'ignore') + then [root.package(obj[k], path + [k], parentWasPackage)] + // If not, keep looking + else find(obj[k], path + [k], parentWasPackage=false) + ), + std.filter( + function(k) + !std.startsWith(k, '#') + && std.isObject(obj[k]), + std.objectFieldsAll(obj) + ), + [] + ), + + packages: find(obj, path), + + hasPackages(): std.length(self.packages) > 0, + + toIndex(relativeTo=[]): + if self.hasPackages() + then + std.join('\n', [ + '* ' + p.link(relativeTo) + for p in self.packages + ]) + + '\n' + else '', + + toFiles(): + std.foldl( + function(acc, p) + acc + + { [p.path]: p.toString() } + + p.packages.toFiles(), + self.packages, + {} + ), + }, + + package(obj, path=[], parentWasPackage=true): { + local this = self, + local doc = obj['#'], + + packages: root.findPackages(obj, path), + fields: root.fields(obj), + + local pathsuffix = + (if self.packages.hasPackages() + then '/index.md' + else '.md'), + + // filepath on disk + path: + std.join('/', path) + + pathsuffix, + + link(relativeTo): + local relativepath = root.util.getRelativePath(path, relativeTo); + '[%s](%s)' % [ + std.join('.', relativepath), + std.join('/', relativepath) + + pathsuffix, + ], + + toFiles(): + { 'README.md': this.toString() } + + self.packages.toFiles(), + + toString(): + std.join( + '\n', + [ + '# ' + doc.name + '\n', + std.get(doc, 'help', ''), + '', + ] + + (if self.packages.hasPackages() + then [ + '## Subpackages\n\n' + + self.packages.toIndex(path), + ] + else []) + + (if self.fields.hasFields() + then [ + '## Index\n\n' + + self.fields.toIndex() + + '\n## Fields\n' + + self.fields.toString(), + ] + else []) + ), + }, + + fields(obj, path=[]): { + values: root.findValues(obj, path), + functions: root.findFunctions(obj, path), + objects: root.findObjects(obj, path), + + hasFields(): + std.any([ + self.values.hasFields(), + self.functions.hasFields(), + self.objects.hasFields(), + ]), + + toIndex(): + std.join('', [ + self.functions.toIndex(), + self.objects.toIndex(), + ]), + + toString(): + std.join('', [ + self.values.toString(), + self.functions.toString(), + self.objects.toString(), + ]), + }, + + findObjects(obj, path=[]): { + local keys = + std.filter( + root.util.filter('object', obj), + std.objectFieldsAll(obj) + ), + + local undocumentedKeys = + std.filter( + function(k) + std.all([ + !std.startsWith(k, '#'), + std.isObject(obj[k]), + !std.objectHasAll(obj[k], 'ignore'), + !('#' + k in obj), // not documented in parent + !('#' in obj[k]), // not a sub package + ]), + std.objectFieldsAll(obj) + ), + + objects: + std.foldl( + function(acc, k) + acc + [ + root.obj( + root.util.realkey(k), + obj[k], + obj[root.util.realkey(k)], + path, + ), + ], + keys, + [] + ) + + std.foldl( + function(acc, k) + local o = root.obj( + k, + { object: { help: '' } }, + obj[k], + path, + ); + acc + + (if o.fields.hasFields() + then [o] + else []), + undocumentedKeys, + [] + ), + + hasFields(): std.length(self.objects) > 0, + + toIndex(): + if self.hasFields() + then + std.join('', [ + std.join( + '', + [' ' for d in std.range(0, (std.length(path) * 2) - 1)] + + ['* ', f.link] + + ['\n'] + + (if f.fields.hasFields() + then [f.fields.toIndex()] + else []) + ) + for f in self.objects + ]) + else '', + + toString(): + if self.hasFields() + then + std.join('', [ + o.toString() + for o in self.objects + ]) + else '', + }, + + obj(name, doc, obj, path): { + fields: root.fields(obj, path + [name]), + + path: std.join('.', path + [name]), + fragment: root.util.fragment(std.join('', path + [name])), + link: '[`obj %s`](#obj-%s)' % [name, self.fragment], + + toString(): + std.join( + '\n', + [root.util.title('obj ' + self.path, std.length(path) + 2)] + + (if std.get(doc.object, 'help', '') != '' + then [doc.object.help] + else []) + + [self.fields.toString()] + ), + }, + + findFunctions(obj, path=[]): { + local keys = + std.filter( + root.util.filter('function', obj), + std.objectFieldsAll(obj) + ), + + functions: + std.foldl( + function(acc, k) + acc + [ + root.func( + root.util.realkey(k), + obj[k], + path, + ), + ], + keys, + [] + ), + + hasFields(): std.length(self.functions) > 0, + + toIndex(): + if self.hasFields() + then + std.join('', [ + std.join( + '', + [' ' for d in std.range(0, (std.length(path) * 2) - 1)] + + ['* ', f.link] + + ['\n'] + ) + for f in self.functions + ]) + else '', + + toString(): + if self.hasFields() + then + std.join('', [ + f.toString() + for f in self.functions + ]) + else '', + }, + + func(name, doc, path): { + path: std.join('.', path + [name]), + fragment: root.util.fragment(std.join('', path + [name])), + link: '[`fn %s(%s)`](#fn-%s)' % [name, self.args, self.fragment], + + local getType(arg) = + local type = + if 'schema' in arg + then std.get(arg.schema, 'type', '') + else std.get(arg, 'type', ''); + if std.isArray(type) + then std.join(',', ['`%s`' % t for t in std.set(type)]) + else '`%s`' % type, + + // Use BelRune as default can be 'null' as a value. Only supported for arg.schema, arg.default didn't support this, not sure how to support without breaking asssumptions downstream. + local BelRune = std.char(7), + local getDefault(arg) = + if 'schema' in arg + then std.get(arg.schema, 'default', BelRune) + else + local d = std.get(arg, 'default', BelRune); + if d == null + then BelRune + else d, + + local getEnum(arg) = + if 'schema' in arg + then std.get(arg.schema, 'enum', []) + else + local d = std.get(arg, 'enums', []); + if d == null + then [] + else d, + + local manifest(value) = + std.manifestJsonEx(value, '', '', ': '), + + args: + std.join(', ', [ + local default = getDefault(arg); + if default != BelRune + then std.join('=', [ + arg.name, + manifest(default), + ]) + else arg.name + for arg in doc['function'].args + ]), + + + args_list: + if std.length(doc['function'].args) > 0 + then + '\nPARAMETERS:\n\n' + + std.join('\n', [ + '* **%s** (%s)' % [arg.name, getType(arg)] + + ( + local default = getDefault(arg); + if default != BelRune + then '\n - default value: `%s`' % manifest(default) + else '' + ) + + ( + local enum = getEnum(arg); + if enum != [] + then + '\n - valid values: %s' % + std.join(', ', [ + '`%s`' % manifest(item) + for item in enum + ]) + else '' + ) + for arg in doc['function'].args + ]) + else '', + + toString(): + std.join('\n', [ + root.util.title('fn ' + self.path, std.length(path) + 2), + ||| + ```jsonnet + %s(%s) + ``` + %s + ||| % [self.path, self.args, self.args_list], + std.get(doc['function'], 'help', ''), + ]), + }, + + findValues(obj, path=[]): { + local keys = + std.filter( + root.util.filter('value', obj), + std.objectFieldsAll(obj) + ), + + values: + std.foldl( + function(acc, k) + acc + [ + root.val( + root.util.realkey(k), + obj[k], + obj[root.util.realkey(k)], + path, + ), + ], + keys, + [] + ), + + hasFields(): std.length(self.values) > 0, + + toString(): + if self.hasFields() + then + std.join('\n', [ + '* ' + f.toString() + for f in self.values + ]) + '\n' + else '', + }, + + val(name, doc, obj, path): { + toString(): + std.join(' ', [ + '`%s`' % std.join('.', path + [name]), + '(`%s`):' % doc.value.type, + '`"%s"`' % obj, + '-', + std.get(doc.value, 'help', ''), + ]), + }, + + util: { + realkey(key): + assert std.startsWith(key, '#') : 'Key %s not a docstring key' % key; + key[1:], + title(title, depth=0): + std.join( + '', + ['\n'] + + ['#' for i in std.range(0, depth)] + + [' ', title, '\n'] + ), + fragment(title): + std.asciiLower( + std.strReplace( + std.strReplace(title, '.', '') + , ' ', '-' + ) + ), + filter(type, obj): + function(k) + std.all([ + std.startsWith(k, '#'), + std.isObject(obj[k]), + !std.objectHasAll(obj[k], 'ignore'), + type in obj[k], + root.util.realkey(k) in obj, + ]), + + getRelativePath(path, relativeTo): + local shortest = std.min(std.length(relativeTo), std.length(path)); + + local commonIndex = + std.foldl( + function(acc, i) ( + if acc.stop + then acc + else + acc + { + // stop count if path diverges + local stop = relativeTo[i] != path[i], + stop: stop, + count+: if stop then 0 else 1, + } + ), + std.range(0, shortest - 1), + { stop: false, count: 0 } + ).count; + + local _relativeTo = relativeTo[commonIndex:]; + local _path = path[commonIndex:]; + + // prefix for relative difference + local prefix = ['..' for i in std.range(0, std.length(_relativeTo) - 1)]; + + // return path with prefix + prefix + _path, + }, +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml b/mixin/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml new file mode 100644 index 0000000..bfe3f82 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/.github/workflows/tests.yml @@ -0,0 +1,32 @@ +name: tests +on: + pull_request: {} + push: + branches: + - main + - master + +jobs: + test: + name: test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make test + run: | + go install github.com/google/go-jsonnet/cmd/jsonnet@latest + go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest + make test + docs: + name: docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make docs + run: | + go install github.com/jsonnet-libs/docsonnet@master + make docs + git diff --exit-code + \ No newline at end of file diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/.gitignore b/mixin/vendor/github.com/jsonnet-libs/xtd/.gitignore new file mode 100644 index 0000000..bb476a1 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/.gitignore @@ -0,0 +1,3 @@ +.jekyll-cache +jsonnetfile.lock.json +vendor diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/LICENSE b/mixin/vendor/github.com/jsonnet-libs/xtd/LICENSE new file mode 100644 index 0000000..0a39b25 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018 grafana, sh0rez + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/Makefile b/mixin/vendor/github.com/jsonnet-libs/xtd/Makefile new file mode 100644 index 0000000..7ffe3aa --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/Makefile @@ -0,0 +1,16 @@ +.PHONY: test +test: + @cd test/; \ + jb install; \ + RESULT=0; \ + for f in $$(find . -path './.git' -prune -o -name 'vendor' -prune -o -name '*_test.jsonnet' -print); do \ + echo "$$f"; \ + jsonnet -J vendor -J lib "$$f"; \ + RESULT=$$(($$RESULT + $$?)); \ + done; \ + exit $$RESULT + + +.PHONY: docs +docs: + docsonnet main.libsonnet diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/README.md b/mixin/vendor/github.com/jsonnet-libs/xtd/README.md new file mode 100644 index 0000000..a060428 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/README.md @@ -0,0 +1,19 @@ +# `xtd` + +`xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). + +## Install + +```console +jb install github.com/jsonnet-libs/xtd +``` + +## Usage + +```jsonnet +local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" +``` + +## Docs + +[docs](docs/README.md) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet new file mode 100644 index 0000000..d32ddb3 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/aggregate.libsonnet @@ -0,0 +1,104 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local this = self, + + '#': d.pkg( + name='aggregate', + url='github.com/jsonnet-libs/xtd/aggregate.libsonnet', + help=||| + `aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. + + Example: + + ```jsonnet + local apps = [ + { + appid: 'id1', + name: 'yo', + id: i, + } + for i in std.range(0, 10) + ]; + + aggregate.byKeys(apps, ['appid', 'name']); + ``` + + Output: + + ```json + { + "id1": { + "yo": [ + { + "appid": "id1", + "id": 0, + "name": "yo" + }, + { + "appid": "id1", + "id": 1, + "name": "yo" + }, + ... + ] + } + } + ``` + |||, + ), + + '#byKey':: d.fn( + ||| + `byKey` aggregates an array by the value of `key` + |||, + [ + d.arg('arr', d.T.array), + d.arg('key', d.T.string), + ] + ), + byKey(arr, key): + // find all values of key + local values = std.set([ + item[key] + for item in arr + ]); + + // create the aggregate for the value of each key + { + [value]: [ + item + for item in std.filter( + function(x) + x[key] == value, + arr + ) + ] + for value in values + }, + + '#byKeys':: d.fn( + ||| + `byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the + aggregate one layer deeper. + |||, + [ + d.arg('arr', d.T.array), + d.arg('keys', d.T.array), + ] + ), + byKeys(arr, keys): + local aggregate = self.byKey(arr, keys[0]); + // if last key in keys + if std.length(keys) == 1 + + // then return aggregate + then aggregate + + // else aggregate with remaining keys + else { + [k]: this.byKeys(aggregate[k], keys[1:]) + for k in std.objectFields(aggregate) + }, + +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/array.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/array.libsonnet new file mode 100644 index 0000000..22a5059 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/array.libsonnet @@ -0,0 +1,69 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='array', + url='github.com/jsonnet-libs/xtd/array.libsonnet', + help='`array` implements helper functions for processing arrays.', + ), + + '#slice':: d.fn( + '`slice` works the same as `std.slice` but with support for negative index/end.', + [ + d.arg('indexable', d.T.array), + d.arg('index', d.T.number), + d.arg('end', d.T.number, default='null'), + d.arg('step', d.T.number, default=1), + ] + ), + slice(indexable, index, end=null, step=1): + local invar = { + index: + if index != null + then + if index < 0 + then std.length(indexable) + index + else index + else 0, + end: + if end != null + then + if end < 0 + then std.length(indexable) + end + else end + else std.length(indexable), + }; + indexable[invar.index:invar.end:step], + + '#filterMapWithIndex':: d.fn( + ||| + `filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. + + `filter_func` and `map_func` function signature: `function(index, array_item)` + |||, + [ + d.arg('filter_func', d.T.func), + d.arg('map_func', d.T.func), + d.arg('arr', d.T.array), + ], + ), + filterMapWithIndex(filter_func, map_func, arr): [ + map_func(i, arr[i]) + for i in std.range(0, std.length(arr) - 1) + if filter_func(i, arr[i]) + ], + + '#chunkArray':: d.fn( + ||| + `chunkArray` chunks an array into smaller arrays of the given max size. + |||, + [ + d.arg('arr', d.T.array), + d.arg('maxSize', d.T.number), + ] + ), + chunkArray(arr, maxSize): [ + arr[i * maxSize:std.min((i + 1) * maxSize, std.length(arr))] + for i in std.range(0, std.ceil(std.length(arr) / maxSize) - 1) + ], +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet new file mode 100644 index 0000000..05c2f38 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/ascii.libsonnet @@ -0,0 +1,132 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='ascii', + url='github.com/jsonnet-libs/xtd/ascii.libsonnet', + help='`ascii` implements helper functions for ascii characters', + ), + + local cp(c) = std.codepoint(c), + + '#isLower':: d.fn( + '`isLower` reports whether ASCII character `c` is a lower case letter', + [d.arg('c', d.T.string)] + ), + isLower(c): cp(c) >= 97 && cp(c) < 123, + + '#isUpper':: d.fn( + '`isUpper` reports whether ASCII character `c` is a upper case letter', + [d.arg('c', d.T.string)] + ), + isUpper(c): cp(c) >= 65 && cp(c) < 91, + + '#isNumber':: d.fn( + '`isNumber` reports whether character `c` is a number.', + [d.arg('c', d.T.string)] + ), + isNumber(c): std.isNumber(c) || (cp(c) >= 48 && cp(c) < 58), + + '#isStringNumeric':: d.fn( + '`isStringNumeric` reports whether string `s` consists only of numeric characters.', + [d.arg('str', d.T.string)] + ), + isStringNumeric(str): std.all(std.map(self.isNumber, std.stringChars(str))), + + '#isStringJSONNumeric':: d.fn( + '`isStringJSONNumeric` reports whether string `s` is a number as defined by [JSON](https://www.json.org/json-en.html).', + [d.arg('str', d.T.string)] + ), + isStringJSONNumeric(str): + // "1" "9" + local onenine(c) = (cp(c) >= 49 && cp(c) <= 57); + + // "0" + local digit(c) = (cp(c) == 48 || onenine(c)); + + local digits(str) = + std.length(str) > 0 + && std.all( + std.foldl( + function(acc, c) + acc + [digit(c)], + std.stringChars(str), + [], + ) + ); + + local fraction(str) = str == '' || (str[0] == '.' && digits(str[1:])); + + local sign(c) = (c == '-' || c == '+'); + + local exponent(str) = + str == '' + || (str[0] == 'E' && digits(str[1:])) + || (str[0] == 'e' && digits(str[1:])) + || (std.length(str) > 1 && str[0] == 'E' && sign(str[1]) && digits(str[2:])) + || (std.length(str) > 1 && str[0] == 'e' && sign(str[1]) && digits(str[2:])); + + + local integer(str) = + (std.length(str) == 1 && digit(str[0])) + || (std.length(str) > 0 && onenine(str[0]) && digits(str[1:])) + || (std.length(str) > 1 && str[0] == '-' && digit(str[1])) + || (std.length(str) > 1 && str[0] == '-' && onenine(str[1]) && digits(str[2:])); + + local expectInteger = + if std.member(str, '.') + then std.split(str, '.')[0] + else if std.member(str, 'e') + then std.split(str, 'e')[0] + else if std.member(str, 'E') + then std.split(str, 'E')[0] + else str; + + local expectFraction = + if std.member(str, 'e') + then std.split(str[std.length(expectInteger):], 'e')[0] + else if std.member(str, 'E') + then std.split(str[std.length(expectInteger):], 'E')[0] + else str[std.length(expectInteger):]; + + local expectExponent = str[std.length(expectInteger) + std.length(expectFraction):]; + + std.all([ + integer(expectInteger), + fraction(expectFraction), + exponent(expectExponent), + ]), + + '#stringToRFC1123': d.fn( + ||| + `stringToRFC113` converts a strings to match RFC1123, replacing non-alphanumeric characters with dashes. It'll throw an assertion if the string is too long. + + * RFC 1123. This means the string must: + * - contain at most 63 characters + * - contain only lowercase alphanumeric characters or '-' + * - start with an alphanumeric character + * - end with an alphanumeric character + |||, + [d.arg('str', d.T.string)] + ), + stringToRFC1123(str): + // lowercase alphabetic characters + local lowercase = std.asciiLower(str); + // replace non-alphanumeric characters with dashes + local alphanumeric = + std.join( + '', + std.map( + function(c) + if self.isLower(c) + || self.isNumber(c) + then c + else '-', + std.stringChars(lowercase) + ) + ); + // remove leading/trailing dashes + local return = std.stripChars(alphanumeric, '-'); + assert std.length(return) <= 63 : 'String too long'; + return, +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet new file mode 100644 index 0000000..ee42c66 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/camelcase.libsonnet @@ -0,0 +1,100 @@ +local xtd = import './main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='camelcase', + url='github.com/jsonnet-libs/xtd/camelcase.libsonnet', + help='`camelcase` can split camelCase words into an array of words.', + ), + + '#split':: d.fn( + ||| + `split` splits a camelcase word and returns an array of words. It also supports + digits. Both lower camel case and upper camel case are supported. It only supports + ASCII characters. + For more info please check: http://en.wikipedia.org/wiki/CamelCase + Based on https://github.com/fatih/camelcase/ + |||, + [d.arg('src', d.T.string)] + ), + split(src): + if src == '' + then [''] + else + local runes = std.foldl( + function(acc, r) + acc { + local class = + if xtd.ascii.isNumber(r) + then 1 + else if xtd.ascii.isLower(r) + then 2 + else if xtd.ascii.isUpper(r) + then 3 + else 4, + + lastClass:: class, + + runes: + if class == super.lastClass + then super.runes[:std.length(super.runes) - 1] + + [super.runes[std.length(super.runes) - 1] + r] + else super.runes + [r], + }, + [src[i] for i in std.range(0, std.length(src) - 1)], + { lastClass:: 0, runes: [] } + ).runes; + + local fixRunes = + std.foldl( + function(runes, i) + if xtd.ascii.isUpper(runes[i][0]) + && xtd.ascii.isLower(runes[i + 1][0]) + && !xtd.ascii.isNumber(runes[i + 1][0]) + && runes[i][0] != ' ' + && runes[i + 1][0] != ' ' + then + std.mapWithIndex( + function(index, r) + if index == i + 1 + then runes[i][std.length(runes[i]) - 1:] + r + else + if index == i + then r[:std.length(r) - 1] + else r + , runes + ) + else runes + , + [i for i in std.range(0, std.length(runes) - 2)], + runes + ); + + [ + r + for r in fixRunes + if r != '' + ], + + '#toCamelCase':: d.fn( + ||| + `toCamelCase` transforms a string to camelCase format, splitting words by the `-`, `_` or spaces. + For example: `hello_world` becomes `helloWorld`. + For more info please check: http://en.wikipedia.org/wiki/CamelCase + |||, + [d.arg('str', d.T.string)] + ), + toCamelCase(str):: + local separators = std.set(std.findSubstr('_', str) + std.findSubstr('-', str) + std.findSubstr(' ', str)); + local n = std.join('', [ + if std.setMember(i - 1, separators) + then std.asciiUpper(str[i]) + else str[i] + for i in std.range(0, std.length(str) - 1) + if !std.setMember(i, separators) + ]); + if std.length(n) == 0 + then n + else std.asciiLower(n[0]) + n[1:], +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/date.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/date.libsonnet new file mode 100644 index 0000000..a8243e7 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/date.libsonnet @@ -0,0 +1,185 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='date', + url='github.com/jsonnet-libs/xtd/date.libsonnet', + help='`time` provides various date related functions.', + ), + + // Lookup tables for calendar calculations + local commonYearMonthLength = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31], + local commonYearMonthOffset = [0, 3, 3, 6, 1, 4, 6, 2, 5, 0, 3, 5], + local leapYearMonthOffset = [0, 3, 4, 0, 2, 5, 0, 3, 6, 1, 4, 6], + + // monthOffset looks up the offset to apply in day of week calculations based on the year and month + local monthOffset(year, month) = + if self.isLeapYear(year) + then leapYearMonthOffset[month - 1] + else commonYearMonthOffset[month - 1], + + '#isLeapYear': d.fn( + '`isLeapYear` returns true if the given year is a leap year.', + [d.arg('year', d.T.number)], + ), + isLeapYear(year):: year % 4 == 0 && (year % 100 != 0 || year % 400 == 0), + + '#dayOfWeek': d.fn( + '`dayOfWeek` returns the day of the week for the given date. 0=Sunday, 1=Monday, etc.', + [ + d.arg('year', d.T.number), + d.arg('month', d.T.number), + d.arg('day', d.T.number), + ], + ), + dayOfWeek(year, month, day):: + (day + monthOffset(year, month) + 5 * ((year - 1) % 4) + 4 * ((year - 1) % 100) + 6 * ((year - 1) % 400)) % 7, + + '#dayOfYear': d.fn( + ||| + `dayOfYear` calculates the ordinal day of the year based on the given date. The range of outputs is 1-365 + for common years, and 1-366 for leap years. + |||, + [ + d.arg('year', d.T.number), + d.arg('month', d.T.number), + d.arg('day', d.T.number), + ], + ), + dayOfYear(year, month, day):: + std.foldl( + function(a, b) a + b, + std.slice(commonYearMonthLength, 0, month - 1, 1), + 0 + ) + day + + if month > 2 && self.isLeapYear(year) + then 1 + else 0, + + // yearSeconds returns the number of seconds in the given year. + local yearSeconds(year) = ( + if $.isLeapYear(year) + then 366 * 24 * 3600 + else 365 * 24 * 3600 + ), + + // monthSeconds returns the number of seconds in the given month of a given year. + local monthSeconds(year, month) = ( + commonYearMonthLength[month - 1] * 24 * 3600 + + if month == 2 && $.isLeapYear(year) then 86400 else 0 + ), + + // sumYearsSeconds returns the number of seconds in all years since 1970 up to year-1. + local sumYearsSeconds(year) = std.foldl( + function(acc, y) acc + yearSeconds(y), + std.range(1970, year - 1), + 0, + ), + + // sumMonthsSeconds returns the number of seconds in all months up to month-1 of the given year. + local sumMonthsSeconds(year, month) = std.foldl( + function(acc, m) acc + monthSeconds(year, m), + std.range(1, month - 1), + 0, + ), + + // sumDaysSeconds returns the number of seconds in all days up to day-1. + local sumDaysSeconds(day) = (day - 1) * 24 * 3600, + + '#toUnixTimestamp': d.fn( + ||| + `toUnixTimestamp` calculates the unix timestamp of a given date. + |||, + [ + d.arg('year', d.T.number), + d.arg('month', d.T.number), + d.arg('day', d.T.number), + d.arg('hour', d.T.number), + d.arg('minute', d.T.number), + d.arg('second', d.T.number), + ], + ), + toUnixTimestamp(year, month, day, hour, minute, second):: + sumYearsSeconds(year) + sumMonthsSeconds(year, month) + sumDaysSeconds(day) + hour * 3600 + minute * 60 + second, + + // isNumeric checks that the input is a non-empty string containing only digit characters. + local isNumeric(input) = + assert std.type(input) == 'string' : 'isNumeric() only operates on string inputs, got %s' % std.type(input); + std.foldl( + function(acc, char) acc && std.codepoint('0') <= std.codepoint(char) && std.codepoint(char) <= std.codepoint('9'), + std.stringChars(input), + std.length(input) > 0, + ), + + // parseSeparatedNumbers parses input which has part `names` separated by `sep`. + // Returns an object which has one field for each name in `names` with its integer value. + local parseSeparatedNumbers(input, sep, names) = ( + assert std.type(input) == 'string' : 'parseSeparatedNumbers() only operates on string inputs, got %s' % std.type(input); + assert std.type(sep) == 'string' : 'parseSeparatedNumbers() only operates on string separators, got %s' % std.type(sep); + assert std.type(names) == 'array' : 'parseSeparatedNumbers() only operates on arrays of names, got input %s' % std.type(names); + + local parts = std.split(input, sep); + assert std.length(parts) == std.length(names) : 'expected %(expected)d parts separated by %(sep)s in %(format)s formatted input "%(input)s", but got %(got)d' % { + expected: std.length(names), + sep: sep, + format: std.join(sep, names), + input: input, + got: std.length(parts), + }; + + { + [names[i]]: + // Fail with meaningful message if not numeric, otherwise it will be a hell to debug. + assert isNumeric(parts[i]) : '%(name)%s part "%(part)s" of %(format)s of input "%(input)s" is not numeric' % { + name: names[i], + part: parts[i], + format: std.join(sep, names), + input: input, + }; + std.parseInt(parts[i]) + for i in std.range(0, std.length(parts) - 1) + } + ), + + // stringContains is a helper function to check whether a string contains a given substring. + local stringContains(haystack, needle) = std.length(std.findSubstr(needle, haystack)) > 0, + + '#parseRFC3339': d.fn( + ||| + `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. + 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. + The returned object has a `toUnixTimestamp()` method that can be used to obtain the unix timestamp of the parsed date. + |||, + [ + d.arg('input', d.T.string), + ], + ), + parseRFC3339(input):: + // Basic input type check. + assert std.type(input) == 'string' : 'parseRFC3339() only operates on string inputs, got %s' % std.type(input); + + // Sub-second precision isn't implemented yet, warn the user about that instead of returning wrong results. + assert !stringContains(input, '.') : 'the provided RFC3339 input "%s" has a dot, most likely representing a sub-second precision, but this function does not support that' % input; + + // We don't support timezones, so string should end with 'Z' or 'z'. + assert std.endsWith(input, 'Z') || std.endsWith(input, 'z') : 'the provided RFC3339 "%s" should end with "Z" or "z". This implementation does not currently support timezones' % input; + + // RFC3339 can separate date and time using 'T', 't' or ' '. + // Find out which one it is and use it. + local sep = + if stringContains(input, 'T') then 'T' + else if stringContains(input, 't') then 't' + else if stringContains(input, ' ') then ' ' + else error 'the provided RFC3339 input "%s" should contain either a "T", or a "t" or space " " as a separator for date and time parts' % input; + + // Split date and time using the selected separator. + // Remove the last character as we know it's 'Z' or 'z' and it's not useful to us. + local datetime = std.split(std.substr(input, 0, std.length(input) - 1), sep); + assert std.length(datetime) == 2 : 'the provided RFC3339 timestamp "%(input)s" does not have date and time parts separated by the character "%(sep)s"' % { input: input, sep: sep }; + + local date = parseSeparatedNumbers(datetime[0], '-', ['year', 'month', 'day']); + local time = parseSeparatedNumbers(datetime[1], ':', ['hour', 'minute', 'second']); + date + time + { + toUnixTimestamp():: $.toUnixTimestamp(self.year, self.month, self.day, self.hour, self.minute, self.second), + }, +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore new file mode 100644 index 0000000..d7951d9 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/.gitignore @@ -0,0 +1,2 @@ +Gemfile.lock +_site diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile new file mode 100644 index 0000000..75d9835 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/Gemfile @@ -0,0 +1,2 @@ +source "https://rubygems.org" +gem "github-pages", group: :jekyll_plugins diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/README.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/README.md new file mode 100644 index 0000000..b5c05d3 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/README.md @@ -0,0 +1,27 @@ +--- +permalink: / +--- + +# xtd + +```jsonnet +local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" +``` + +`xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). + +This package serves as a test field for functions intended to be contributed to `std` +in the future, but also provides a place for less general, yet useful utilities. + + +* [aggregate](aggregate.md) +* [array](array.md) +* [ascii](ascii.md) +* [camelcase](camelcase.md) +* [date](date.md) +* [inspect](inspect.md) +* [jsonpath](jsonpath.md) +* [number](number.md) +* [string](string.md) +* [units](units.md) +* [url](url.md) \ No newline at end of file diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml new file mode 100644 index 0000000..d18a288 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/_config.yml @@ -0,0 +1,2 @@ +theme: jekyll-theme-cayman +baseurl: /xtd diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md new file mode 100644 index 0000000..a877ddf --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/aggregate.md @@ -0,0 +1,74 @@ +--- +permalink: /aggregate/ +--- + +# aggregate + +```jsonnet +local aggregate = import "github.com/jsonnet-libs/xtd/aggregate.libsonnet" +``` + +`aggregate` implements helper functions to aggregate arrays of objects into objects with arrays. + +Example: + +```jsonnet +local apps = [ + { + appid: 'id1', + name: 'yo', + id: i, + } + for i in std.range(0, 10) +]; + +aggregate.byKeys(apps, ['appid', 'name']); +``` + +Output: + +```json +{ + "id1": { + "yo": [ + { + "appid": "id1", + "id": 0, + "name": "yo" + }, + { + "appid": "id1", + "id": 1, + "name": "yo" + }, + ... + ] + } +} +``` + + +## Index + +* [`fn byKey(arr, key)`](#fn-bykey) +* [`fn byKeys(arr, keys)`](#fn-bykeys) + +## Fields + +### fn byKey + +```ts +byKey(arr, key) +``` + +`byKey` aggregates an array by the value of `key` + + +### fn byKeys + +```ts +byKeys(arr, keys) +``` + +`byKey` aggregates an array by iterating over `keys`, each item in `keys` nests the +aggregate one layer deeper. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/array.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/array.md new file mode 100644 index 0000000..93642d8 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/array.md @@ -0,0 +1,47 @@ +--- +permalink: /array/ +--- + +# array + +```jsonnet +local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" +``` + +`array` implements helper functions for processing arrays. + +## Index + +* [`fn chunkArray(arr, maxSize)`](#fn-chunkarray) +* [`fn filterMapWithIndex(filter_func, map_func, arr)`](#fn-filtermapwithindex) +* [`fn slice(indexable, index, end='null', step=1)`](#fn-slice) + +## Fields + +### fn chunkArray + +```ts +chunkArray(arr, maxSize) +``` + +`chunkArray` chunks an array into smaller arrays of the given max size. + + +### fn filterMapWithIndex + +```ts +filterMapWithIndex(filter_func, map_func, arr) +``` + +`filterMapWithIndex` works the same as `std.filterMap` with the addition that the index is passed to the functions. + +`filter_func` and `map_func` function signature: `function(index, array_item)` + + +### fn slice + +```ts +slice(indexable, index, end='null', step=1) +``` + +`slice` works the same as `std.slice` but with support for negative index/end. \ No newline at end of file diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md new file mode 100644 index 0000000..95382d5 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/ascii.md @@ -0,0 +1,76 @@ +--- +permalink: /ascii/ +--- + +# ascii + +```jsonnet +local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" +``` + +`ascii` implements helper functions for ascii characters + +## Index + +* [`fn isLower(c)`](#fn-islower) +* [`fn isNumber(c)`](#fn-isnumber) +* [`fn isStringJSONNumeric(str)`](#fn-isstringjsonnumeric) +* [`fn isStringNumeric(str)`](#fn-isstringnumeric) +* [`fn isUpper(c)`](#fn-isupper) +* [`fn stringToRFC1123(str)`](#fn-stringtorfc1123) + +## Fields + +### fn isLower + +```ts +isLower(c) +``` + +`isLower` reports whether ASCII character `c` is a lower case letter + +### fn isNumber + +```ts +isNumber(c) +``` + +`isNumber` reports whether character `c` is a number. + +### fn isStringJSONNumeric + +```ts +isStringJSONNumeric(str) +``` + +`isStringJSONNumeric` reports whether string `s` is a number as defined by [JSON](https://www.json.org/json-en.html). + +### fn isStringNumeric + +```ts +isStringNumeric(str) +``` + +`isStringNumeric` reports whether string `s` consists only of numeric characters. + +### fn isUpper + +```ts +isUpper(c) +``` + +`isUpper` reports whether ASCII character `c` is a upper case letter + +### fn stringToRFC1123 + +```ts +stringToRFC1123(str) +``` + +`stringToRFC113` converts a strings to match RFC1123, replacing non-alphanumeric characters with dashes. It'll throw an assertion if the string is too long. + +* RFC 1123. This means the string must: +* - contain at most 63 characters +* - contain only lowercase alphanumeric characters or '-' +* - start with an alphanumeric character +* - end with an alphanumeric character diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md new file mode 100644 index 0000000..6c52147 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/camelcase.md @@ -0,0 +1,41 @@ +--- +permalink: /camelcase/ +--- + +# camelcase + +```jsonnet +local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" +``` + +`camelcase` can split camelCase words into an array of words. + +## Index + +* [`fn split(src)`](#fn-split) +* [`fn toCamelCase(str)`](#fn-tocamelcase) + +## Fields + +### fn split + +```ts +split(src) +``` + +`split` splits a camelcase word and returns an array of words. It also supports +digits. Both lower camel case and upper camel case are supported. It only supports +ASCII characters. +For more info please check: http://en.wikipedia.org/wiki/CamelCase +Based on https://github.com/fatih/camelcase/ + + +### fn toCamelCase + +```ts +toCamelCase(str) +``` + +`toCamelCase` transforms a string to camelCase format, splitting words by the `-`, `_` or spaces. +For example: `hello_world` becomes `helloWorld`. +For more info please check: http://en.wikipedia.org/wiki/CamelCase diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/date.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/date.md new file mode 100644 index 0000000..1fcb9eb --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/date.md @@ -0,0 +1,66 @@ +--- +permalink: /date/ +--- + +# date + +```jsonnet +local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" +``` + +`time` provides various date related functions. + +## Index + +* [`fn dayOfWeek(year, month, day)`](#fn-dayofweek) +* [`fn dayOfYear(year, month, day)`](#fn-dayofyear) +* [`fn isLeapYear(year)`](#fn-isleapyear) +* [`fn parseRFC3339(input)`](#fn-parserfc3339) +* [`fn toUnixTimestamp(year, month, day, hour, minute, second)`](#fn-tounixtimestamp) + +## Fields + +### fn dayOfWeek + +```ts +dayOfWeek(year, month, day) +``` + +`dayOfWeek` returns the day of the week for the given date. 0=Sunday, 1=Monday, etc. + +### fn dayOfYear + +```ts +dayOfYear(year, month, day) +``` + +`dayOfYear` calculates the ordinal day of the year based on the given date. The range of outputs is 1-365 +for common years, and 1-366 for leap years. + + +### fn isLeapYear + +```ts +isLeapYear(year) +``` + +`isLeapYear` returns true if the given year is a leap year. + +### fn parseRFC3339 + +```ts +parseRFC3339(input) +``` + +`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. +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. +The returned object has a `toUnixTimestamp()` method that can be used to obtain the unix timestamp of the parsed date. + + +### fn toUnixTimestamp + +```ts +toUnixTimestamp(year, month, day, hour, minute, second) +``` + +`toUnixTimestamp` calculates the unix timestamp of a given date. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md new file mode 100644 index 0000000..da6ef61 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/inspect.md @@ -0,0 +1,103 @@ +--- +permalink: /inspect/ +--- + +# inspect + +```jsonnet +local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" +``` + +`inspect` implements helper functions for inspecting Jsonnet + +## Index + +* [`fn deepMap(func, x)`](#fn-deepmap) +* [`fn diff(input1, input2)`](#fn-diff) +* [`fn filterKubernetesObjects(object, kind='')`](#fn-filterkubernetesobjects) +* [`fn filterObjects(filter_func, x)`](#fn-filterobjects) +* [`fn inspect(object, maxDepth)`](#fn-inspect) + +## Fields + +### fn deepMap + +```ts +deepMap(func, x) +``` + +`deepMap` traverses the whole tree of `x` and applies `func(item)` indiscriminately. + + +### fn diff + +```ts +diff(input1, input2) +``` + +`diff` returns a JSON object describing the differences between two inputs. It +attemps to show diffs in nested objects and arrays too. + +Simple example: + +```jsonnet +local input1 = { + same: 'same', + change: 'this', + remove: 'removed', +}; + +local input2 = { + same: 'same', + change: 'changed', + add: 'added', +}; + +diff(input1, input2), +``` + +Output: +```json +{ + "add +": "added", + "change ~": "~[ this , changed ]", + "remove -": "removed" +} +``` + + +### fn filterKubernetesObjects + +```ts +filterKubernetesObjects(object, kind='') +``` + +`filterKubernetesObjects` implements `filterObjects` to return all Kubernetes objects in +an array, assuming that Kubernetes object are characterized by having an +`apiVersion` and `kind` field. + +The `object` argument can either be an object or an array, other types will be +ignored. The `kind` allows to filter out a specific kind, if unset all kinds will +be returned. + + +### fn filterObjects + +```ts +filterObjects(filter_func, x) +``` + +`filterObjects` walks a JSON tree returning all matching objects in an array. + +The `x` argument can either be an object or an array, other types will be +ignored. + + +### fn inspect + +```ts +inspect(object, maxDepth) +``` + +`inspect` reports the structure of a Jsonnet object with a recursion depth of +`maxDepth` (default maxDepth=10). diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md new file mode 100644 index 0000000..94a4a4b --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/jsonpath.md @@ -0,0 +1,53 @@ +--- +permalink: /jsonpath/ +--- + +# jsonpath + +```jsonnet +local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" +``` + +`jsonpath` implements helper functions to use JSONPath expressions. + +## Index + +* [`fn convertBracketToDot(path)`](#fn-convertbrackettodot) +* [`fn getJSONPath(source, path, default='null')`](#fn-getjsonpath) +* [`fn parseFilterExpr(path)`](#fn-parsefilterexpr) + +## Fields + +### fn convertBracketToDot + +```ts +convertBracketToDot(path) +``` + +`convertBracketToDot` converts the bracket notation to dot notation. + +This function does not support escaping brackets/quotes in path keys. + + +### fn getJSONPath + +```ts +getJSONPath(source, path, default='null') +``` + +`getJSONPath` gets the value at `path` from `source` where path is a JSONPath. + +This is a rudimentary implementation supporting the slice operator `[0:3:2]` and +partially supporting filter expressions `?(@.attr==value)`. + + +### fn parseFilterExpr + +```ts +parseFilterExpr(path) +``` + +`parseFilterExpr` returns a filter function `f(x)` for a filter expression `expr`. + + It supports comparisons (<, <=, >, >=) and equality checks (==, !=). If it doesn't + have an operator, it will check if the `expr` value exists. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/number.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/number.md new file mode 100644 index 0000000..aa30879 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/number.md @@ -0,0 +1,43 @@ +--- +permalink: /number/ +--- + +# number + +```jsonnet +local number = import "github.com/jsonnet-libs/xtd/number.libsonnet" +``` + +`number` implements helper functions for processing number. + +## Index + +* [`fn inRange(v, from, to)`](#fn-inrange) +* [`fn maxInArray(arr, default=0)`](#fn-maxinarray) +* [`fn minInArray(arr, default=0)`](#fn-mininarray) + +## Fields + +### fn inRange + +```ts +inRange(v, from, to) +``` + +`inRange` returns true if `v` is in the given from/to range.` + +### fn maxInArray + +```ts +maxInArray(arr, default=0) +``` + +`maxInArray` finds the biggest number in an array + +### fn minInArray + +```ts +minInArray(arr, default=0) +``` + +`minInArray` finds the smallest number in an array \ No newline at end of file diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/string.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/string.md new file mode 100644 index 0000000..2642e1b --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/string.md @@ -0,0 +1,42 @@ +--- +permalink: /string/ +--- + +# string + +```jsonnet +local string = import "github.com/jsonnet-libs/xtd/string.libsonnet" +``` + +`string` implements helper functions for processing strings. + +## Index + +* [`fn splitEscape(str, c, escape='\\')`](#fn-splitescape) +* [`fn strReplaceMulti(str, replacements)`](#fn-strreplacemulti) + +## Fields + +### fn splitEscape + +```ts +splitEscape(str, c, escape='\\') +``` + +`split` works the same as `std.split` but with support for escaping the dividing +string `c`. + + +### fn strReplaceMulti + +```ts +strReplaceMulti(str, replacements) +``` + +`strReplaceMulti` replaces multiple substrings in a string. + +Example: +```jsonnet +strReplaceMulti('hello world', [['hello', 'goodbye'], ['world', 'universe']]) +// 'goodbye universe' +``` diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/units.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/units.md new file mode 100644 index 0000000..a3ae762 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/units.md @@ -0,0 +1,61 @@ +--- +permalink: /units/ +--- + +# units + +```jsonnet +local units = import "github.com/jsonnet-libs/xtd/units.libsonnet" +``` + +`units` implements helper functions for converting units. + +## Index + +* [`fn formatDuration(seconds)`](#fn-formatduration) +* [`fn parseDuration(duration)`](#fn-parseduration) +* [`fn parseKubernetesCPU(input)`](#fn-parsekubernetescpu) +* [`fn siToBytes(str)`](#fn-sitobytes) + +## Fields + +### fn formatDuration + +```ts +formatDuration(seconds) +``` + +`formatDuration` formats a number of seconds into a human-readable duration string. +Returns the duration in the smallest appropriate unit (s, m, h, or combined formats like "4m30s"). + + +### fn parseDuration + +```ts +parseDuration(duration) +``` + +`parseDuration` parses a duration string and returns the number of seconds. +Handles milliseconds (ms), seconds (s), minutes (m), hours (h), and combined formats like "4m30s" or "1h30m". + + +### fn parseKubernetesCPU + +```ts +parseKubernetesCPU(input) +``` + +`parseKubernetesCPU` parses a Kubernetes CPU string/number into a number of cores. + The function assumes the input is in a correct Kubernetes format, i.e., an integer, a float, + a string representation of an integer or a float, or a string containing a number ending with 'm' + representing a number of millicores. + + +### fn siToBytes + +```ts +siToBytes(str) +``` + +`siToBytes` converts Kubernetes byte units to bytes. +Only works for limited set of SI prefixes: Ki, Mi, Gi, Ti. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/docs/url.md b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/url.md new file mode 100644 index 0000000..db898bc --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/docs/url.md @@ -0,0 +1,56 @@ +--- +permalink: /url/ +--- + +# url + +```jsonnet +local url = import "github.com/jsonnet-libs/xtd/url.libsonnet" +``` + +`url` provides functions to deal with URLs + +## Index + +* [`fn encodeQuery(params)`](#fn-encodequery) +* [`fn escapeString(str, excludedChars=[])`](#fn-escapestring) +* [`fn join(splitObj)`](#fn-join) +* [`fn parse(url)`](#fn-parse) + +## Fields + +### fn encodeQuery + +```ts +encodeQuery(params) +``` + +`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string + +### fn escapeString + +```ts +escapeString(str, excludedChars=[]) +``` + +`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences + +### fn join + +```ts +join(splitObj) +``` + +`join` joins URLs from the object generated from `parse` + +### fn parse + +```ts +parse(url) +``` + +`parse` parses absolute and relative URLs. + +:///;parameters?# + +Inspired by Python's urllib.urlparse, following several RFC specifications. diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet new file mode 100644 index 0000000..47abcd9 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/inspect.libsonnet @@ -0,0 +1,227 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + local this = self, + + '#': d.pkg( + name='inspect', + url='github.com/jsonnet-libs/xtd/inspect.libsonnet', + help='`inspect` implements helper functions for inspecting Jsonnet', + ), + + '#inspect':: d.fn( + ||| + `inspect` reports the structure of a Jsonnet object with a recursion depth of + `maxDepth` (default maxDepth=10). + |||, + [ + d.arg('object', d.T.object), + d.arg('maxDepth', d.T.number), + //d.arg('depth', d.T.number), // used for recursion, not exposing in docs + ] + ), + inspect(object, maxDepth=10, depth=0): + std.foldl( + function(acc, p) + acc + ( + if std.isObject(object[p]) + && depth != maxDepth + then { [p]+: + this.inspect( + object[p], + maxDepth, + depth + 1 + ) } + else { + [ + (if !std.objectHas(object, p) + then 'hidden_' + else '') + + (if std.isFunction(object[p]) + then 'functions' + else 'fields') + ]+: [p], + } + ), + std.objectFieldsAll(object), + {} + ), + + '#diff':: d.fn( + ||| + `diff` returns a JSON object describing the differences between two inputs. It + attemps to show diffs in nested objects and arrays too. + + Simple example: + + ```jsonnet + local input1 = { + same: 'same', + change: 'this', + remove: 'removed', + }; + + local input2 = { + same: 'same', + change: 'changed', + add: 'added', + }; + + diff(input1, input2), + ``` + + Output: + ```json + { + "add +": "added", + "change ~": "~[ this , changed ]", + "remove -": "removed" + } + ``` + |||, + [ + d.arg('input1', d.T.any), + d.arg('input2', d.T.any), + ] + ), + diff(input1, input2):: + if input1 == input2 + then '' + else if std.isArray(input1) && std.isArray(input2) + then + [ + if input1[i] != input2[i] + then + this.diff( + input1[i], + input2[i] + ) + else input2[i] + for i in std.range(0, std.length(input2) - 1) + if std.length(input1) > i + ] + + (if std.length(input1) < std.length(input2) + then [ + '+ ' + input2[i] + for i in std.range(std.length(input1), std.length(input2) - 1) + ] + else []) + + (if std.length(input1) > std.length(input2) + then [ + '- ' + input1[i] + for i in std.range(std.length(input2), std.length(input1) - 1) + ] + else []) + + else if std.isObject(input1) && std.isObject(input2) + then std.foldl( + function(acc, k) + acc + ( + if k in input1 && input1[k] != input2[k] + then { + [k + ' ~']: + this.diff( + input1[k], + input2[k] + ), + } + else if !(k in input1) + then { + [k + ' +']: input2[k], + } + else {} + ), + std.objectFields(input2), + {}, + ) + + { + [l + ' -']: input1[l] + for l in std.objectFields(input1) + if !(l in input2) + } + + else '~[ %s ]' % std.join(' , ', [std.toString(input1), std.toString(input2)]), + + '#filterObjects':: d.fn( + ||| + `filterObjects` walks a JSON tree returning all matching objects in an array. + + The `x` argument can either be an object or an array, other types will be + ignored. + |||, + args=[ + d.arg('filter_func', d.T.func), + d.arg('x', d.T.any), + ] + ), + filterObjects(filter_func, x): + if std.isObject(x) + then + if filter_func(x) + then [x] + else + std.foldl( + function(acc, o) + acc + self.filterObjects(filter_func, x[o]), + std.objectFields(x), + [] + ) + else if std.isArray(x) + then + std.flattenArrays( + std.map( + function(obj) + self.filterObjects(filter_func, obj), + x + ) + ) + else [], + + '#filterKubernetesObjects':: d.fn( + ||| + `filterKubernetesObjects` implements `filterObjects` to return all Kubernetes objects in + an array, assuming that Kubernetes object are characterized by having an + `apiVersion` and `kind` field. + + The `object` argument can either be an object or an array, other types will be + ignored. The `kind` allows to filter out a specific kind, if unset all kinds will + be returned. + |||, + args=[ + d.arg('object', d.T.any), + d.arg('kind', d.T.string, default=''), + ] + ), + filterKubernetesObjects(object, kind=''): + local objects = self.filterObjects( + function(object) + std.objectHas(object, 'apiVersion') + && std.objectHas(object, 'kind'), + object, + ); + if kind == '' + then objects + else + std.filter( + function(o) o.kind == kind, + objects + ), + + '#deepMap':: d.fn( + ||| + `deepMap` traverses the whole tree of `x` and applies `func(item)` indiscriminately. + |||, + args=[ + d.arg('func', d.T.func), + d.arg('x', d.T.any), + ] + ), + deepMap(func, x): + func( + if std.isObject(x) + then std.mapWithKey(function(_, y) self.deepMap(func, y), x) + else if std.isArray(x) + then std.map(function(y) self.deepMap(func, y), x) + else x + ), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet new file mode 100644 index 0000000..49f15bc --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/jsonpath.libsonnet @@ -0,0 +1,142 @@ +local xtd = import './main.libsonnet'; +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='jsonpath', + url='github.com/jsonnet-libs/xtd/jsonpath.libsonnet', + help='`jsonpath` implements helper functions to use JSONPath expressions.', + ), + + + '#getJSONPath':: d.fn( + ||| + `getJSONPath` gets the value at `path` from `source` where path is a JSONPath. + + This is a rudimentary implementation supporting the slice operator `[0:3:2]` and + partially supporting filter expressions `?(@.attr==value)`. + |||, + [ + d.arg('source', d.T.any), + d.arg('path', d.T.string,), + d.arg('default', d.T.any, default='null'), + ] + ), + getJSONPath(source, path, default=null): + local _path = self.convertBracketToDot(path); + std.foldl( + function(acc, key) + if acc == null + then acc + else get(acc, key, default), + xtd.string.splitEscape(_path, '.'), + source, + ), + + '#convertBracketToDot':: d.fn( + ||| + `convertBracketToDot` converts the bracket notation to dot notation. + + This function does not support escaping brackets/quotes in path keys. + |||, + [ + d.arg('path', d.T.string,), + ] + ), + convertBracketToDot(path): + if std.length(std.findSubstr('[', path)) > 0 + then + local split = std.split(path, '['); + std.join('.', [ + local a = std.stripChars(i, "[]'"); + std.strReplace(a, '@.', '@\\.') + for i in split + ]) + else path, + + local get(source, key, default) = + if key == '' + || key == '$' + || key == '*' + then source + else if std.isArray(source) + then getFromArray(source, key) + else std.get(source, key, default), + + local getFromArray(arr, key) = + if std.startsWith(key, '?(@\\.') + then + std.filter( + self.parseFilterExpr(std.stripChars(key, '?(@\\.)')), + arr + ) + else if std.length(std.findSubstr(':', key)) >= 1 + then + local split = std.splitLimit(key, ':', 2); + local step = + if std.length(split) < 3 + then 1 + else parseIntOrNull(split[2]); + xtd.array.slice( + arr, + parseIntOrNull(split[0]), + parseIntOrNull(split[1]), + step, + ) + else + arr[std.parseInt(key)], + + local parseIntOrNull(str) = + if str == '' + then null + else std.parseInt(str), + + '#parseFilterExpr':: d.fn( + ||| + `parseFilterExpr` returns a filter function `f(x)` for a filter expression `expr`. + + It supports comparisons (<, <=, >, >=) and equality checks (==, !=). If it doesn't + have an operator, it will check if the `expr` value exists. + |||, + [ + d.arg('path', d.T.string,), + ] + ), + parseFilterExpr(expr): + local operandFunctions = { + '=='(a, b): a == b, + '!='(a, b): a != b, + '<='(a, b): a <= b, + '>='(a, b): a >= b, + '<'(a, b): a < b, + '>'(a, b): a > b, + }; + + local findOperands = std.filter( + function(op) std.length(std.findSubstr(op, expr)) > 0, + std.reverse( // reverse to match '<=' before '<' + std.objectFields(operandFunctions) + ) + ); + + if std.length(findOperands) > 0 + then + local op = findOperands[0]; + local s = [ + std.stripChars(i, ' ') + for i in std.splitLimit(expr, op, 1) + ]; + function(x) + if s[0] in x + then + local left = x[s[0]]; + local right = + if std.isNumber(left) + then std.parseInt(s[1]) // Only parse if comparing numbers + else s[1]; + operandFunctions[op](left, right) + else false + else + // Default to key matching + function(x) (expr in x), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/main.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/main.libsonnet new file mode 100644 index 0000000..3edfdc3 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/main.libsonnet @@ -0,0 +1,26 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='xtd', + url='github.com/jsonnet-libs/xtd/main.libsonnet', + help=||| + `xtd` aims to collect useful functions not included in the Jsonnet standard library (`std`). + + This package serves as a test field for functions intended to be contributed to `std` + in the future, but also provides a place for less general, yet useful utilities. + |||, + ), + + aggregate: (import './aggregate.libsonnet'), + array: (import './array.libsonnet'), + ascii: (import './ascii.libsonnet'), + camelcase: (import './camelcase.libsonnet'), + date: (import './date.libsonnet'), + inspect: (import './inspect.libsonnet'), + jsonpath: (import './jsonpath.libsonnet'), + number: (import './number.libsonnet'), + string: (import './string.libsonnet'), + units: (import './units.libsonnet'), + url: (import './url.libsonnet'), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/number.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/number.libsonnet new file mode 100644 index 0000000..6ebdece --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/number.libsonnet @@ -0,0 +1,48 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='number', + url='github.com/jsonnet-libs/xtd/number.libsonnet', + help='`number` implements helper functions for processing number.', + ), + + '#inRange':: d.fn( + '`inRange` returns true if `v` is in the given from/to range.`', + [ + d.arg('v', d.T.number), + d.arg('from', d.T.number), + d.arg('to', d.T.number), + ] + ), + inRange(v, from, to): + v > from && v <= to, + + '#maxInArray':: d.fn( + '`maxInArray` finds the biggest number in an array', + [ + d.arg('arr', d.T.array), + d.arg('default', d.T.number, default=0), + ] + ), + maxInArray(arr, default=0): + std.foldl( + std.max, + std.set(arr), + default, + ), + + '#minInArray':: d.fn( + '`minInArray` finds the smallest number in an array', + [ + d.arg('arr', d.T.array), + d.arg('default', d.T.number, default=0), + ] + ), + minInArray(arr, default=0): + std.foldl( + std.min, + std.set(arr), + default, + ), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/string.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/string.libsonnet new file mode 100644 index 0000000..5dccf13 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/string.libsonnet @@ -0,0 +1,61 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='string', + url='github.com/jsonnet-libs/xtd/string.libsonnet', + help='`string` implements helper functions for processing strings.', + ), + + // BelRune is a string of the Ascii character BEL which made computers ring in ancient times. + // We use it as "magic" char to temporarily replace an escaped string as it is a non printable + // character and thereby will unlikely be in a valid key by accident. Only when we include it. + local BelRune = std.char(7), + + '#splitEscape':: d.fn( + ||| + `split` works the same as `std.split` but with support for escaping the dividing + string `c`. + |||, + [ + d.arg('str', d.T.string), + d.arg('c', d.T.string), + d.arg('escape', d.T.string, default='\\'), + ] + ), + splitEscape(str, c, escape='\\'): + std.map( + function(i) + std.strReplace(i, BelRune, escape + c), + std.split( + std.strReplace(str, escape + c, BelRune), + c, + ) + ), + + '#strReplaceMulti':: d.fn( + ||| + `strReplaceMulti` replaces multiple substrings in a string. + + Example: + ```jsonnet + strReplaceMulti('hello world', [['hello', 'goodbye'], ['world', 'universe']]) + // 'goodbye universe' + ``` + |||, + [ + d.arg('str', d.T.string), + d.arg('replacements', d.T.array), + ] + ), + strReplaceMulti(str, replacements): + assert std.isString(str) : 'str must be a string'; + assert std.isArray(replacements) : 'replacements must be an array'; + assert std.all([std.isArray(r) && std.length(r) == 2 && std.isString(r[0]) && std.isString(r[1]) for r in replacements]) : 'replacements must be an array of arrays of strings'; + std.foldl( + function(acc, replacement) + std.strReplace(acc, replacement[0], replacement[1]), + replacements, + str, + ), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet new file mode 100644 index 0000000..4c9a36e --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/array_test.jsonnet @@ -0,0 +1,113 @@ +local array = import '../array.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +local arr = std.range(0, 10); +local mixedArr = ['a', 1, 'b', 2, 'c', 3, 4, 5, 6, 7, 8, 9, 'd', 'e', 'f', 'g', 'h', 'i', 'j']; + +test.new(std.thisFile) + ++ test.case.new( + name='first two', + test=test.expect.eq( + actual=array.slice( + arr, + index=0, + end=2, + ), + expected=[0, 1], + ) +) ++ test.case.new( + name='last two', + test=test.expect.eq( + actual=array.slice( + arr, + index=1, + end=3, + ), + expected=[1, 2], + ) +) ++ test.case.new( + name='until end', + test=test.expect.eq( + actual=array.slice( + arr, + index=1 + ), + expected=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10], + ) +) ++ test.case.new( + name='from beginning', + test=test.expect.eq( + actual=array.slice( + arr, + index=0, + end=2 + ), + expected=[0, 1], + ) +) ++ test.case.new( + name='negative start', + test=test.expect.eq( + actual=array.slice( + arr, + index=-2 + ), + expected=[9, 10], + ) +) ++ test.case.new( + name='negative end', + test=test.expect.eq( + actual=array.slice( + arr, + index=0, + end=-1 + ), + expected=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9], + ) +) ++ test.case.new( + name='step', + test=test.expect.eq( + actual=array.slice( + arr, + index=0, + end=5, + step=2 + ), + expected=[0, 2, 4], + ) +) + ++ test.case.new( + name='chunkArray', + test=test.expect.eq( + actual=array.chunkArray(mixedArr, maxSize=3), + expected=[['a', 1, 'b'], [2, 'c', 3], [4, 5, 6], [7, 8, 9], ['d', 'e', 'f'], ['g', 'h', 'i'], ['j']], + ) +) ++ test.case.new( + name='chunkArray - maxSize is 2', + test=test.expect.eq( + actual=array.chunkArray(mixedArr, maxSize=2), + expected=[['a', 1], ['b', 2], ['c', 3], [4, 5], [6, 7], [8, 9], ['d', 'e'], ['f', 'g'], ['h', 'i'], ['j']], + ) +) ++ test.case.new( + name='chunkArray - maxSize is larger than array length', + test=test.expect.eq( + actual=array.chunkArray(mixedArr, maxSize=100), + expected=[mixedArr], + ) +) ++ test.case.new( + name='chunkArray - maxSize is 1', + test=test.expect.eq( + actual=array.chunkArray(mixedArr, maxSize=1), + expected=[['a'], [1], ['b'], [2], ['c'], [3], [4], [5], [6], [7], [8], [9], ['d'], ['e'], ['f'], ['g'], ['h'], ['i'], ['j']], + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet new file mode 100644 index 0000000..f8b3f6b --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/ascii_test.jsonnet @@ -0,0 +1,92 @@ +local ascii = import '../ascii.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='all numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('123'), + expected=true, + ) +) + ++ test.case.new( + name='only beginning numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('123abc'), + expected=false, + ) +) + ++ test.case.new( + name='only end numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('abc123'), + expected=false, + ) +) + ++ test.case.new( + name='none numeric', + test=test.expect.eq( + actual=ascii.isStringNumeric('abc'), + expected=false, + ) +) + ++ test.case.new( + name='empty', + test=test.expect.eq( + actual=ascii.isStringNumeric(''), + expected=true, + ) +) + ++ std.foldl( + function(acc, str) + acc + + test.case.new( + name='valid: ' + str, + test=test.expect.eq( + actual=ascii.isStringJSONNumeric(str), + expected=true, + ) + ), + [ + '15', + '1.5', + '-1.5', + '1e5', + '1E5', + '1.5e5', + '1.5E5', + '1.5e-5', + '1.5E+5', + ], + {}, +) ++ std.foldl( + function(acc, str) + acc + + test.case.new( + name='invalid: ' + str, + test=test.expect.eq( + actual=ascii.isStringJSONNumeric(str), + expected=false, + ) + ), + [ + '15e', + '1.', + '+', + '+1E5', + '.5', + 'E5', + 'e5', + '15e5garbage', + '1garbag5e5garbage', + 'garbage15e5garbage', + ], + {}, +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet new file mode 100644 index 0000000..2dcadc0 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/camelcase_test.jsonnet @@ -0,0 +1,193 @@ +local xtd = import '../main.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='split: nostring', + test=test.expect.eq( + actual=xtd.camelcase.split(''), + expected=[''], + ) +) ++ test.case.new( + name='split: lowercase', + test=test.expect.eq( + actual=xtd.camelcase.split('lowercase'), + expected=['lowercase'], + ) +) ++ test.case.new( + name='split: Class', + test=test.expect.eq( + actual=xtd.camelcase.split('Class'), + expected=['Class'], + ) +) ++ test.case.new( + name='split: MyClass', + test=test.expect.eq( + actual=xtd.camelcase.split('MyClass'), + expected=['My', 'Class'], + ) +) ++ test.case.new( + name='split: MyC', + test=test.expect.eq( + actual=xtd.camelcase.split('MyC'), + expected=['My', 'C'], + ) +) ++ test.case.new( + name='split: HTML', + test=test.expect.eq( + actual=xtd.camelcase.split('HTML'), + expected=['HTML'], + ) +) ++ test.case.new( + name='split: PDFLoader', + test=test.expect.eq( + actual=xtd.camelcase.split('PDFLoader'), + expected=['PDF', 'Loader'], + ) +) ++ test.case.new( + name='split: AString', + test=test.expect.eq( + actual=xtd.camelcase.split('AString'), + expected=['A', 'String'], + ) +) ++ test.case.new( + name='split: SimpleXMLParser', + test=test.expect.eq( + actual=xtd.camelcase.split('SimpleXMLParser'), + expected=['Simple', 'XML', 'Parser'], + ) +) ++ test.case.new( + name='split: vimRPCPlugin', + test=test.expect.eq( + actual=xtd.camelcase.split('vimRPCPlugin'), + expected=['vim', 'RPC', 'Plugin'], + ) +) ++ test.case.new( + name='split: GL11Version', + test=test.expect.eq( + actual=xtd.camelcase.split('GL11Version'), + expected=['GL', '11', 'Version'], + ) +) ++ test.case.new( + name='split: 99Bottles', + test=test.expect.eq( + actual=xtd.camelcase.split('99Bottles'), + expected=['99', 'Bottles'], + ) +) ++ test.case.new( + name='split: May5', + test=test.expect.eq( + actual=xtd.camelcase.split('May5'), + expected=['May', '5'], + ) +) ++ test.case.new( + name='split: BFG9000', + test=test.expect.eq( + actual=xtd.camelcase.split('BFG9000'), + expected=['BFG', '9000'], + ) +) ++ test.case.new( + name='split: Two spaces', + test=test.expect.eq( + actual=xtd.camelcase.split('Two spaces'), + expected=['Two', ' ', 'spaces'], + ) +) ++ test.case.new( + name='split: Multiple Random spaces', + test=test.expect.eq( + actual=xtd.camelcase.split('Multiple Random spaces'), + expected=['Multiple', ' ', 'Random', ' ', 'spaces'], + ) +) ++ test.case.new( + name='toCamelCase: empty string', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase(''), + expected='', + ) +) ++ test.case.new( + name='toCamelCase: lowercase', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lowercase'), + expected='lowercase', + ) +) ++ test.case.new( + name='toCamelCase: underscores', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower_case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: dashes', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower-case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: spaces', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: mixed', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower_case-mixed'), + expected='lowerCaseMixed', + ) +) ++ test.case.new( + name='toCamelCase: multiple spaces', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('lower case'), + expected='lowerCase', + ) +) ++ test.case.new( + name='toCamelCase: PascalCase', + test=test.expect.eq( + actual=xtd.camelcase.toCamelCase('PascalCase'), + expected='pascalCase', + ) +) + +// TODO: find or create is(Upper|Lower) for non-ascii characters +// Something like this for Jsonnet: +// https://cs.opensource.google/go/go/+/refs/tags/go1.17.3:src/unicode/tables.go +//+ test.case.new( +// name='BöseÜberraschung', +// test=test.expect.eq( +// actual=xtd.camelcase.split('BöseÜberraschung'), +// expected=['Böse', 'Überraschung'], +// ) +//) + +// This doesn't even render in Jsonnet +//+ test.case.new( +// name="BadUTF8\xe2\xe2\xa1", +// test=test.expect.eq( +// actual=xtd.camelcase.split("BadUTF8\xe2\xe2\xa1"), +// expected=["BadUTF8\xe2\xe2\xa1"], +// ) +//) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet new file mode 100644 index 0000000..9746428 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/date_test.jsonnet @@ -0,0 +1,219 @@ +local xtd = import '../main.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='Leap Year commonYear', + test=test.expect.eq( + actual=xtd.date.isLeapYear(1995), + expected=false, + ) +) + ++ test.case.new( + name='Leap Year fourYearCycle', + test=test.expect.eq( + actual=xtd.date.isLeapYear(1996), + expected=true, + ) +) + ++ test.case.new( + name='Leap Year fourHundredYearCycle', + test=test.expect.eq( + actual=xtd.date.isLeapYear(2000), + expected=true, + ) +) + ++ test.case.new( + name='Leap Year hundredYearCycle', + test=test.expect.eq( + actual=xtd.date.isLeapYear(2100), + expected=false, + ) +) + ++ test.case.new( + name='Day Of Week leapYearStart', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(2000, 1, 1), + expected=6, + ) +) + ++ test.case.new( + name='Day Of Week leapYearEnd', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(2000, 12, 31), + expected=0, + ) +) + ++ test.case.new( + name='Day Of Week commonYearStart', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(1995, 1, 1), + expected=0, + ) +) + ++ test.case.new( + name='Day Of Week commonYearEnd', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(2003, 12, 31), + expected=3, + ) +) + ++ test.case.new( + name='Day Of Week leapYearMid', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(2024, 7, 19), + expected=5, + ) +) + ++ test.case.new( + name='Day Of Week commonYearMid', + test=test.expect.eq( + actual=xtd.date.dayOfWeek(2023, 6, 15), + expected=4, + ) +) ++ test.case.new( + name='Day Of Year leapYearStart', + test=test.expect.eq( + actual=xtd.date.dayOfYear(2000, 1, 1), + expected=1, + ) +) + ++ test.case.new( + name='Day Of Year leapYearEnd', + test=test.expect.eq( + actual=xtd.date.dayOfYear(2000, 12, 31), + expected=366, + ) +) + ++ test.case.new( + name='Day Of Year commonYearStart', + test=test.expect.eq( + actual=xtd.date.dayOfYear(1995, 1, 1), + expected=1, + ) +) + ++ test.case.new( + name='Day Of Year commonYearEnd', + test=test.expect.eq( + actual=xtd.date.dayOfYear(2003, 12, 31), + expected=365, + ) +) + ++ test.case.new( + name='Day Of Year leapYearMid', + test=test.expect.eq( + actual=xtd.date.dayOfYear(2024, 7, 19), + expected=201, + ) +) + ++ test.case.new( + name='Day Of Year commonYearMid', + test=test.expect.eq( + actual=xtd.date.dayOfYear(2023, 6, 15), + expected=166, + ) +) + ++ test.case.new( + name='toUnixTimestamp of 1970-01-01 00:00:00 (zero)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1970, 1, 1, 0, 0, 0), + expected=0, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1970-01-02 00:00:00 (one day)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1970, 1, 2, 0, 0, 0), + expected=86400, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1971-01-01 00:00:00 (one year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1971, 1, 1, 0, 0, 0), + expected=365 * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1972-03-01 00:00:00 (month of leap year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1972, 3, 1, 0, 0, 0), + expected=2 * 365 * 24 * 3600 + 31 * 24 * 3600 + 29 * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 1974-01-01 00:00:00 (incl leap year)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(1974, 1, 1, 0, 0, 0), + expected=(4 * 365 + 1) * 24 * 3600, + ), +) + ++ test.case.new( + name='toUnixTimestamp of 2020-01-02 03:04:05 (full date)', + test=test.expect.eq( + actual=xtd.date.toUnixTimestamp(2020, 1, 2, 3, 4, 5), + expected=1577934245, + ), +) + ++ test.case.new( + name='parseRFC3339 of 1970-01-01T00:00:00Z (standard unix zero)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('1970-01-01T00:00:00Z'), + expected={ year: 1970, month: 1, day: 1, hour: 0, minute: 0, second: 0 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02T03:04:05Z (non-zero date)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02T03:04:05Z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02 03:04:05Z (space separator)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02 03:04:05Z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339 of 2020-01-02t03:04:05Z (lowercase t separator and lowercase z)', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02t03:04:05z'), + expected={ year: 2020, month: 1, day: 2, hour: 3, minute: 4, second: 5 }, + ), +) + ++ test.case.new( + name='parseRFC3339(..).toUnixTimestamp()', + test=test.expect.eq( + actual=xtd.date.parseRFC3339('2020-01-02T03:04:05Z').toUnixTimestamp(), + expected=1577934245, + ), +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet new file mode 100644 index 0000000..b2c0d15 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/inspect_test.jsonnet @@ -0,0 +1,191 @@ +local xtd = import '../main.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='emptyobject', + test=test.expect.eq( + actual=xtd.inspect.inspect({}), + expected={} + ) +) + ++ test.case.new( + name='flatObject', + test=test.expect.eq( + actual=xtd.inspect.inspect({ + key: 'value', + hidden_key:: 'value', + func(value): value, + hidden_func(value):: value, + }), + expected={ + fields: ['key'], + hidden_fields: ['hidden_key'], + functions: ['func'], + hidden_functions: ['hidden_func'], + } + ) +) + ++ test.case.new( + name='nestedObject', + test=test.expect.eq( + actual=xtd.inspect.inspect({ + nested: { + key: 'value', + hidden_key:: 'value', + func(value): value, + hidden_func(value):: value, + }, + key: 'value', + hidden_func(value):: value, + }), + expected={ + nested: { + fields: ['key'], + hidden_fields: ['hidden_key'], + functions: ['func'], + hidden_functions: ['hidden_func'], + }, + fields: ['key'], + hidden_functions: ['hidden_func'], + } + ) +) + ++ test.case.new( + name='maxRecursionDepth', + test=test.expect.eq( + actual=xtd.inspect.inspect({ + key: 'value', + nested: { + key: 'value', + nested: { + key: 'value', + }, + }, + }, maxDepth=1), + expected={ + fields: ['key'], + nested: { + fields: ['key', 'nested'], + }, + } + ) +) + ++ test.case.new( + name='noDiff', + test=test.expect.eq( + actual=xtd.inspect.diff('', ''), + expected='' + ) +) ++ test.case.new( + name='typeDiff', + test=test.expect.eq( + actual=xtd.inspect.diff('string', true), + expected='~[ string , true ]' + ) +) ++ ( + local input1 = { + same: 'same', + change: 'this', + remove: 'removed', + }; + local input2 = { + same: 'same', + change: 'changed', + add: 'added', + }; + test.case.new( + name='objectDiff', + test=test.expect.eq( + actual=xtd.inspect.diff(input1, input2), + expected={ + 'add +': 'added', + 'change ~': '~[ this , changed ]', + 'remove -': 'removed', + } + ) + ) +) + ++ ( + local input1 = [ + 'same', + 'this', + [ + 'same', + 'this', + ], + 'remove', + ]; + local input2 = [ + 'same', + 'changed', + [ + 'same', + 'changed', + 'added', + ], + ]; + test.case.new( + name='arrayDiff', + test=test.expect.eq( + actual=xtd.inspect.diff(input1, input2), + expected=[ + 'same', + '~[ this , changed ]', + [ + 'same', + '~[ this , changed ]', + '+ added', + ], + '- remove', + ] + ) + ) +) ++ ( + local originalObj = { + key1: { + key1a: 'replace me', + key1b: [ + { key1bNested: 'replace me' }, + ], + }, + key2: [ + { key2a: 'replace me' }, + ], + }; + + test.case.new( + name='deepmap', + test= + test.expect.eq( + actual=xtd.inspect.deepMap( + function(item) + if std.isString(item) + && item == 'replace me' + then 'REPLACED' + else item, + originalObj, + ), + expected={ + key1: { + key1a: 'REPLACED', + key1b: [ + { key1bNested: 'REPLACED' }, + ], + }, + key2: [ + { key2a: 'REPLACED' }, + ], + } + ) + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json b/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json new file mode 100644 index 0000000..ce9ad4d --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonnetfile.json @@ -0,0 +1,15 @@ +{ + "version": 1, + "dependencies": [ + { + "source": { + "git": { + "remote": "https://github.com/jsonnet-libs/testonnet.git", + "subdir": "" + } + }, + "version": "master" + } + ], + "legacyImports": true +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet new file mode 100644 index 0000000..8c1106b --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/jsonpath_test.jsonnet @@ -0,0 +1,305 @@ +local jsonpath = import '../jsonpath.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + +// Root ++ test.case.new( + name='root $', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, '$'), + expected={ key: 'content' }, + ) +) ++ test.case.new( + name='root (empty path)', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, ''), + expected={ key: 'content' }, + ) +) ++ test.case.new( + name='root .', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, '.'), + expected={ key: 'content' }, + ) +) + +// Single key ++ test.case.new( + name='path without dot prefix', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, 'key'), + expected='content', + ) +) ++ test.case.new( + name='single key', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, '.key'), + expected='content', + ) +) ++ test.case.new( + name='single bracket key', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, '[key]'), + expected='content', + ) +) ++ test.case.new( + name='single bracket key with $', + test=test.expect.eq( + actual=jsonpath.getJSONPath({ key: 'content' }, '$[key]'), + expected='content', + ) +) ++ test.case.new( + name='single array index', + test=test.expect.eq( + actual=jsonpath.getJSONPath(['content'], '.[0]'), + expected='content', + ) +) ++ test.case.new( + name='single array index without dot prefix', + test=test.expect.eq( + actual=jsonpath.getJSONPath(['content'], '[0]'), + expected='content', + ) +) + +// Nested ++ test.case.new( + name='nested key', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: { key3: 'content' } } }, + '.key1.key2.key3' + ), + expected='content', + ) +) ++ test.case.new( + name='nested bracket key', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: { key3: 'content' } } }, + '.key1.key2[key3]' + ), + expected='content', + ) +) ++ test.case.new( + name='nested bracket key (quoted)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: { key3: 'content' } } }, + ".key1.key2['key3']" + ), + expected='content', + ) +) ++ test.case.new( + name='nested bracket star key', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: { key3: 'content' } } }, + '.key1.key2[*]' + ), + expected={ key3: 'content' }, + ) +) ++ test.case.new( + name='nested array index', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + '.key1.key2[1]' + ), + expected='content2', + ) +) ++ test.case.new( + name='nested array index with $', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + '$.key1.key2[1]' + ), + expected='content2', + ) +) ++ test.case.new( + name='nested array index without brackets', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + '.key1.key2.1' + ), + expected='content2', + ) +) ++ test.case.new( + name='nested array star index', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + '.key1.key2[*]' + ), + expected=['content1', 'content2'], + ) +) ++ test.case.new( + name='nested bracket keys and array index combo', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + '$.[key1][key2][1]' + ), + expected='content2', + ) +) ++ test.case.new( + name='all keys in bracket and quoted', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key1: { key2: ['content1', 'content2'] } }, + "$['key1']['key2']" + ), + expected=['content1', 'content2'], + ) +) + +// index range/slice ++ test.case.new( + name='array with index range (first two)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[0:2]' + ), + expected=['content1', 'content2'], + ) +) ++ test.case.new( + name='array with index range (last two)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[1:3]' + ), + expected=['content2', 'content3'], + ) +) ++ test.case.new( + name='array with index range (until end)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[1:]' + ), + expected=['content2', 'content3'], + ) +) ++ test.case.new( + name='array with index range (from beginning)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[:2]' + ), + expected=['content1', 'content2'], + ) +) ++ test.case.new( + name='array with index range (negative start)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[-2:]' + ), + expected=['content2', 'content3'], + ) +) ++ test.case.new( + name='array with index range (negative end)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: ['content1', 'content2', 'content3'] }, + 'key[:-1]' + ), + expected=['content1', 'content2'], + ) +) ++ test.case.new( + name='array with index range (step)', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: [ + 'content%s' % i + for i in std.range(1, 10) + ] }, + 'key[:5:2]' + ), + expected=['content1', 'content3', 'content5'], + ) +) + +// filter expr ++ test.case.new( + name='array with filter expression - string', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: [ + { + key: 'content%s' % i, + } + for i in std.range(1, 10) + ] }, + '.key[?(@.key==content2)]' + ), + expected=[{ + key: 'content2', + }], + ) +) ++ test.case.new( + name='array with filter expression - number', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: [ + { + count: i, + } + for i in std.range(1, 10) + ] }, + '.key[?(@.count<=2)]' + ), + expected=[{ + count: 1, + }, { + count: 2, + }], + ) +) ++ test.case.new( + name='array with filter expression - has key', + test=test.expect.eq( + actual=jsonpath.getJSONPath( + { key: [ + { + key1: 'value', + }, + { + key2: 'value', + }, + ] }, + '.key[?(@.key1)]' + ), + expected=[{ + key1: 'value', + }], + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/string_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/string_test.jsonnet new file mode 100644 index 0000000..4f375eb --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/string_test.jsonnet @@ -0,0 +1,33 @@ +local string = import '../string.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) + ++ test.case.new( + name='strReplaceMulti', + test=test.expect.eq( + actual=string.strReplaceMulti('hello world', [['hello', 'goodbye'], ['world', 'universe']]), + expected='goodbye universe', + ) +) ++ test.case.new( + name='strReplaceMulti - chained', + test=test.expect.eq( + actual=string.strReplaceMulti('hello world', [['hello', 'goodbye'], ['goodbye', 'hi again']]), + expected='hi again world', + ) +) ++ test.case.new( + name='strReplaceMulti - not found', + test=test.expect.eq( + actual=string.strReplaceMulti('hello world', [['first', 'second'], ['third', 'fourth']]), + expected='hello world', + ) +) ++ test.case.new( + name='strReplaceMulti - empty replacements', + test=test.expect.eq( + actual=string.strReplaceMulti('hello world', []), + expected='hello world', + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/units_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/units_test.jsonnet new file mode 100644 index 0000000..d2f4459 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/units_test.jsonnet @@ -0,0 +1,248 @@ +local units = import '../units.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) +// parseCPU(10) = parseCPU("10") = 10 +// parseCPU(4.5) = parse("4.5") = 4.5 +// parseCPU("3000m") = 3000 / 1000 +// parseCPU("3580m") = 3580 / 1000 +// parseCPU("3980.7m") = 3980.7 / 1000 +// parseCPU(0.5) = parse("0.5") = parse("500m") = 0.5 ++ test.case.new( + name='parseCPU - integer', + test=test.expect.eq( + actual=units.parseKubernetesCPU(10), + expected=10, + ) +) ++ test.case.new( + name='parseCPU - string integer', + test=test.expect.eq( + actual=units.parseKubernetesCPU('10'), + expected=10, + ) +) ++ test.case.new( + name='parseCPU - float', + test=test.expect.eq( + actual=units.parseKubernetesCPU(4.5), + expected=4.5, + ) +) ++ test.case.new( + name='parseCPU - string float', + test=test.expect.eq( + actual=units.parseKubernetesCPU('4.5'), + expected=4.5, + ) +) ++ test.case.new( + name='parseCPU - string millicores', + test=test.expect.eq( + actual=units.parseKubernetesCPU('3000m'), + expected=3, + ) +) ++ test.case.new( + name='parseCPU - string millicores', + test=test.expect.eq( + actual=units.parseKubernetesCPU('3580m'), + expected=3.58, + ) +) ++ test.case.new( + name='parseCPU - string millicores', + test=test.expect.eq( + actual=units.parseKubernetesCPU('3980.7m'), + expected=3980.7 / 1000, // Use a division to avoid floating point precision issues + ) +) ++ test.case.new( + name='parseCPU - fraction', + test=test.expect.eq( + actual=units.parseKubernetesCPU(0.5), + expected=0.5, + ) +) ++ test.case.new( + name='parseCPU - string fraction', + test=test.expect.eq( + actual=units.parseKubernetesCPU('0.5'), + expected=0.5, + ) +) ++ test.case.new( + name='parseCPU - fraction millicores', + test=test.expect.eq( + actual=units.parseKubernetesCPU('500m'), + expected=0.5, + ) +) + +// siToBytes tests ++ test.case.new( + name='siToBytes - plain number', + test=test.expect.eq( + actual=units.siToBytes('1024'), + expected=1024, + ) +) ++ test.case.new( + name='siToBytes - Ki', + test=test.expect.eq( + actual=units.siToBytes('1Ki'), + expected=1024, + ) +) ++ test.case.new( + name='siToBytes - Mi', + test=test.expect.eq( + actual=units.siToBytes('1Mi'), + expected=1048576, + ) +) ++ test.case.new( + name='siToBytes - Gi', + test=test.expect.eq( + actual=units.siToBytes('2Gi'), + expected=2147483648, + ) +) ++ test.case.new( + name='siToBytes - Ti', + test=test.expect.eq( + actual=units.siToBytes('1Ti'), + expected=1099511627776, + ) +) ++ test.case.new( + name='siToBytes - fractional Ki', + test=test.expect.eq( + actual=units.siToBytes('1.5Ki'), + expected=1536, + ) +) + +// parseDuration tests ++ test.case.new( + name='parseDuration - milliseconds', + test=test.expect.eq( + actual=units.parseDuration('500ms'), + expected=0.5, + ) +) ++ test.case.new( + name='parseDuration - seconds', + test=test.expect.eq( + actual=units.parseDuration('30s'), + expected=30, + ) +) ++ test.case.new( + name='parseDuration - minutes', + test=test.expect.eq( + actual=units.parseDuration('5m'), + expected=300, + ) +) ++ test.case.new( + name='parseDuration - hours', + test=test.expect.eq( + actual=units.parseDuration('2h'), + expected=7200, + ) +) ++ test.case.new( + name='parseDuration - combined minutes and seconds', + test=test.expect.eq( + actual=units.parseDuration('4m30s'), + expected=270, + ) +) ++ test.case.new( + name='parseDuration - combined hours and fractional seconds', + test=test.expect.eq( + actual=units.parseDuration('1h30.5s'), + expected=3600 + 30.5, + ) +) ++ test.case.new( + name='parseDuration - combined hours and minutes', + test=test.expect.eq( + actual=units.parseDuration('1h30m'), + expected=5400, + ) +) ++ test.case.new( + name='parseDuration - combined hours and milliseconds', + test=test.expect.eq( + actual=units.parseDuration('1h500ms'), + expected=3600 + 0.5, + ) +) + +// formatDuration tests ++ test.case.new( + name='formatDuration - milliseconds', + test=test.expect.eq( + actual=units.formatDuration(0.5), + expected='500ms', + ) +) ++ test.case.new( + name='formatDuration - seconds', + test=test.expect.eq( + actual=units.formatDuration(45), + expected='45s', + ) +) ++ test.case.new( + name='formatDuration - minutes', + test=test.expect.eq( + actual=units.formatDuration(300), + expected='5m', + ) +) ++ test.case.new( + name='formatDuration - hours', + test=test.expect.eq( + actual=units.formatDuration(7200), + expected='2h', + ) +) ++ test.case.new( + name='formatDuration - combined minutes and seconds', + test=test.expect.eq( + actual=units.formatDuration(270), + expected='4m30s', + ) +) ++ test.case.new( + name='formatDuration - combined hours and minutes', + test=test.expect.eq( + actual=units.formatDuration(5400), + expected='1h30m', + ) +) ++ test.case.new( + name='formatDuration - combined hours and minutes and seconds', + test=test.expect.eq( + actual=units.formatDuration(5400 + 30), + expected='1h30m30s', + ) +) ++ test.case.new( + name='formatDuration - combined hours and minutes and seconds and milliseconds', + test=test.expect.eq( + actual=units.formatDuration(5400 + 30 + 0.5), + expected='1h30m30s500ms', + ) +) + ++ test.case.new( + name='formatDuration - combined hours and milliseconds', + test=test.expect.eq( + actual=units.formatDuration(3600 + 0.5), + expected='1h500ms', + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet new file mode 100644 index 0000000..b2393a2 --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/test/url_test.jsonnet @@ -0,0 +1,209 @@ +local xtd = import '../main.libsonnet'; +local test = import 'github.com/jsonnet-libs/testonnet/main.libsonnet'; + +test.new(std.thisFile) ++ test.case.new( + name='empty', + test=test.expect.eq( + actual=xtd.url.escapeString(''), + expected='', + ) +) + ++ test.case.new( + name='abc', + test=test.expect.eq( + actual=xtd.url.escapeString('abc'), + expected='abc', + ) +) + ++ test.case.new( + name='space', + test=test.expect.eq( + actual=xtd.url.escapeString('one two'), + expected='one%20two', + ) +) + ++ test.case.new( + name='percent', + test=test.expect.eq( + actual=xtd.url.escapeString('10%'), + expected='10%25', + ) +) + ++ test.case.new( + name='complex', + test=test.expect.eq( + actual=xtd.url.escapeString(" ?&=#+%!<>#\"{}|\\^[]`☺\t:/@$'()*,;"), + expected='%20%3F%26%3D%23%2B%25%21%3C%3E%23%22%7B%7D%7C%5C%5E%5B%5D%60%E2%98%BA%09%3A%2F%40%24%27%28%29%2A%2C%3B', + ) +) + ++ test.case.new( + name='exclusions', + test=test.expect.eq( + actual=xtd.url.escapeString('hello, world', [',']), + expected='hello,%20world', + ) +) + ++ test.case.new( + name='multiple exclusions', + test=test.expect.eq( + actual=xtd.url.escapeString('hello, world,&', [',', '&']), + expected='hello,%20world,&', + ) +) + ++ test.case.new( + name='empty', + test=test.expect.eq( + actual=xtd.url.encodeQuery({}), + expected='', + ) +) + ++ test.case.new( + name='simple', + test=test.expect.eq( + actual=xtd.url.encodeQuery({ q: 'puppies', oe: 'utf8' }), + expected='oe=utf8&q=puppies', + ) +) + +// url.parse ++ test.case.new( + name='Full absolute URL', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location;type=person?name=john#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + params: 'type=person', + query: 'name=john', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL with fragment before params and query', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location#address;type=person?name=john'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + fragment: 'address;type=person?name=john', + }, + ) +) + ++ test.case.new( + name='URL without query', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location;type=person#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + params: 'type=person', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL without params', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location?name=john#address'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + query: 'name=john', + fragment: 'address', + }, + ) +) + ++ test.case.new( + name='URL with empty fragment', + test=test.expect.eqJson( + actual=xtd.url.parse('https://example.com/path/to/location#'), + expected={ + scheme: 'https', + netloc: 'example.com', + hostname: 'example.com', + path: '/path/to/location', + fragment: '', + }, + ) +) + ++ test.case.new( + name='host with port', + test=test.expect.eqJson( + actual=xtd.url.parse('//example.com:80'), + expected={ + netloc: 'example.com:80', + hostname: 'example.com', + port: '80', + }, + ) +) + ++ test.case.new( + name='mailto', + test=test.expect.eqJson( + actual=xtd.url.parse('mailto:john@example.com'), + expected={ + scheme: 'mailto', + path: 'john@example.com', + }, + ) +) + ++ test.case.new( + name='UserInfo', + test=test.expect.eqJson( + actual=xtd.url.parse('ftp://admin:password@example.com'), + + expected={ + hostname: 'example.com', + netloc: 'admin:password@example.com', + scheme: 'ftp', + username: 'admin', + password: 'password', + } + , + ) +) + ++ test.case.new( + name='Relative URL only', + test=test.expect.eqJson( + actual=xtd.url.parse('/path/to/location'), + expected={ + path: '/path/to/location', + }, + ) +) + ++ test.case.new( + name='URL fragment only', + test=test.expect.eqJson( + actual=xtd.url.parse('#fragment_only'), + expected={ + fragment: 'fragment_only', + }, + ) +) diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/units.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/units.libsonnet new file mode 100644 index 0000000..9d3bdca --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/units.libsonnet @@ -0,0 +1,93 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='units', + url='github.com/jsonnet-libs/xtd/units.libsonnet', + help='`units` implements helper functions for converting units.', + ), + + '#parseKubernetesCPU':: d.fn( + ||| + `parseKubernetesCPU` parses a Kubernetes CPU string/number into a number of cores. + The function assumes the input is in a correct Kubernetes format, i.e., an integer, a float, + a string representation of an integer or a float, or a string containing a number ending with 'm' + representing a number of millicores. + |||, + [ + d.arg('input', d.T.any), + ] + ), + parseKubernetesCPU(input): + if std.isString(input) && std.endsWith(input, 'm') then std.parseJson(std.rstripChars(input, 'm')) / 1000 + else if std.isString(input) then std.parseJson(input) + else if std.isNumber(input) then input + else 0, + + '#siToBytes':: d.fn( + ||| + `siToBytes` converts Kubernetes byte units to bytes. + Only works for limited set of SI prefixes: Ki, Mi, Gi, Ti. + |||, + [ + d.arg('str', d.T.string), + ] + ), + siToBytes(str): + local siToBytesDecimal(str) = + if std.endsWith(str, 'Ki') then + std.parseJson(std.rstripChars(str, 'Ki')) * std.pow(2, 10) + else if std.endsWith(str, 'Mi') then + std.parseJson(std.rstripChars(str, 'Mi')) * std.pow(2, 20) + else if std.endsWith(str, 'Gi') then + std.parseJson(std.rstripChars(str, 'Gi')) * std.pow(2, 30) + else if std.endsWith(str, 'Ti') then + std.parseJson(std.rstripChars(str, 'Ti')) * std.pow(2, 40) + else + std.parseJson(str); + std.floor(siToBytesDecimal(str)), + + '#parseDuration':: d.fn( + ||| + `parseDuration` parses a duration string and returns the number of seconds. + Handles milliseconds (ms), seconds (s), minutes (m), hours (h), and combined formats like "4m30s" or "1h30m". + |||, + [ + d.arg('duration', d.T.string), + ] + ), + parseDuration(duration): + local replaced = std.strReplace(duration, 'ms', 'n'); // replace ms with n to avoid confusion with minutes + + local splitH = std.split(replaced, 'h'); + local hours = if std.length(splitH) > 1 then std.parseJson(splitH[0]) else 0; + local withoutHours = if std.length(splitH) > 1 then splitH[1] else replaced; + + local splitM = std.split(withoutHours, 'm'); + local minutes = if std.length(splitM) > 1 then std.parseJson(splitM[0]) else 0; + local withoutMinutes = if std.length(splitM) > 1 then splitM[1] else withoutHours; + + local splitS = std.split(withoutMinutes, 's'); + local seconds = if std.length(splitS) > 1 then std.parseJson(splitS[0]) else 0; + local withoutSeconds = if std.length(splitS) > 1 then splitS[1] else withoutMinutes; + + local splitN = std.split(withoutSeconds, 'n'); + local milliseconds = if std.length(splitN) > 1 then std.parseJson(splitN[0]) else 0; + + hours * 3600 + minutes * 60 + seconds + milliseconds / 1000, + + '#formatDuration':: d.fn( + ||| + `formatDuration` formats a number of seconds into a human-readable duration string. + Returns the duration in the smallest appropriate unit (s, m, h, or combined formats like "4m30s"). + |||, + [ + d.arg('seconds', d.T.number), + ] + ), + formatDuration(seconds): + (if std.floor(seconds / 3600) > 0 then '%dh' % (seconds / 3600) else '') + + (if std.floor((seconds % 3600) / 60) > 0 then '%dm' % ((seconds % 3600) / 60) else '') + + (if (seconds % 60) > 1 then '%ds' % (seconds % 60) else '') + + (if seconds % 1 > 0 then '%dms' % ((seconds % 1) * 1000) else ''), +} diff --git a/mixin/vendor/github.com/jsonnet-libs/xtd/url.libsonnet b/mixin/vendor/github.com/jsonnet-libs/xtd/url.libsonnet new file mode 100644 index 0000000..1509c0f --- /dev/null +++ b/mixin/vendor/github.com/jsonnet-libs/xtd/url.libsonnet @@ -0,0 +1,111 @@ +local d = import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet'; + +{ + '#': d.pkg( + name='url', + url='github.com/jsonnet-libs/xtd/url.libsonnet', + help='`url` provides functions to deal with URLs', + ), + + '#escapeString': d.fn( + '`escapeString` escapes the given string so it can be safely placed inside an URL, replacing special characters with `%XX` sequences', + args=[ + d.arg('str', d.T.string), + d.arg('excludedChars', d.T.array, default=[]), + ], + ), + escapeString(str, excludedChars=[]):: + local allowedChars = '0123456789abcdefghijklmnopqrstuvwqxyzABCDEFGHIJKLMNOPQRSTUVWQXYZ'; + local utf8(char) = std.foldl(function(a, b) a + '%%%02X' % b, std.encodeUTF8(char), ''); + local escapeChar(char) = if std.member(excludedChars, char) || std.member(allowedChars, char) then char else utf8(char); + std.join('', std.map(escapeChar, std.stringChars(str))), + + '#encodeQuery': d.fn( + '`encodeQuery` takes an object of query parameters and returns them as an escaped `key=value` string', + args=[d.arg('params', d.T.object)], + ), + encodeQuery(params):: + local fmtParam(p) = '%s=%s' % [self.escapeString(p), self.escapeString(params[p])]; + std.join('&', std.map(fmtParam, std.objectFields(params))), + + '#parse': d.fn( + ||| + `parse` parses absolute and relative URLs. + + :///;parameters?# + + Inspired by Python's urllib.urlparse, following several RFC specifications. + |||, + args=[d.arg('url', d.T.string)], + ), + parse(url): + local hasFragment = std.member(url, '#'); + local fragmentSplit = std.splitLimit(url, '#', 1); + local fragment = fragmentSplit[1]; + + local hasQuery = std.member(fragmentSplit[0], '?'); + local querySplit = std.splitLimit(fragmentSplit[0], '?', 1); + local query = querySplit[1]; + + local hasParams = std.member(querySplit[0], ';'); + local paramsSplit = std.splitLimit(querySplit[0], ';', 1); + local params = paramsSplit[1]; + + local hasNetLoc = std.member(paramsSplit[0], '//'); + local netLocSplit = std.splitLimit(paramsSplit[0], '//', 1); + local netLoc = std.splitLimit(netLocSplit[1], '/', 1)[0]; + + local hasScheme = std.member(netLocSplit[0], ':'); + local schemeSplit = std.splitLimit(netLocSplit[0], ':', 1); + local scheme = schemeSplit[0]; + + local path = + if hasNetLoc && std.member(netLocSplit[1], '/') + then '/' + std.splitLimit(netLocSplit[1], '/', 1)[1] + else if hasScheme + then schemeSplit[1] + else netLocSplit[0]; + local hasPath = (path != ''); + + local hasUserInfo = hasNetLoc && std.member(netLoc, '@'); + local userInfoSplit = std.reverse(std.splitLimitR(netLoc, '@', 1)); + local userInfo = userInfoSplit[1]; + + local hasPassword = hasUserInfo && std.member(userInfo, ':'); + local passwordSplit = std.splitLimitR(userInfo, ':', 1); + local username = passwordSplit[0]; + local password = passwordSplit[1]; + + local hasPort = hasNetLoc && std.length(std.findSubstr(':', userInfoSplit[0])) > 0; + local portSplit = std.splitLimitR(userInfoSplit[0], ':', 1); + local host = portSplit[0]; + local port = portSplit[1]; + + { + [if hasScheme then 'scheme']: scheme, + [if hasNetLoc then 'netloc']: netLoc, + [if hasPath then 'path']: path, + [if hasParams then 'params']: params, + [if hasQuery then 'query']: query, + [if hasFragment then 'fragment']: fragment, + + [if hasUserInfo then 'username']: username, + [if hasPassword then 'password']: password, + [if hasNetLoc then 'hostname']: host, + [if hasPort then 'port']: port, + }, + + '#join': d.fn( + '`join` joins URLs from the object generated from `parse`', + args=[d.arg('splitObj', d.T.object)], + ), + join(splitObj): + std.join('', [ + if 'scheme' in splitObj then splitObj.scheme + ':' else '', + if 'netloc' in splitObj then '//' + splitObj.netloc else '', + if 'path' in splitObj then splitObj.path else '', + if 'params' in splitObj then ';' + splitObj.params else '', + if 'query' in splitObj then '?' + splitObj.query else '', + if 'fragment' in splitObj then '#' + splitObj.fragment else '', + ]), +} diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/BUILD.bazel b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/BUILD.bazel new file mode 100644 index 0000000..51bcc35 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/BUILD.bazel @@ -0,0 +1,17 @@ +package(default_visibility = ["//visibility:public"]) + +licenses(["notice"]) # Apache 2.0 + +load("@io_bazel_rules_jsonnet//jsonnet:jsonnet.bzl", "jsonnet_library") + +exports_files(["jsonnetunit.bzl"]) + +jsonnet_library( + name = "jsonnetunit", + srcs = [ + "matcher.libsonnet", + "std_matchers.libsonnet", + "test.libsonnet", + ], + visibility = ["//visibility:public"], +) diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/jsonnetunit.bzl b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/jsonnetunit.bzl new file mode 100644 index 0000000..a1e6bdc --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/jsonnetunit.bzl @@ -0,0 +1,25 @@ +load("@io_bazel_rules_jsonnet//jsonnet:jsonnet.bzl", "jsonnet_to_json_test") + +def jsonnet_test(name, src, deps=[], **kwargs): + """Runs a jsonnetunit test + + Args: + name: A unique name for this rule + src: A `.jsonnet` which contains a jsonnetunit test suite + deps: List of `jsonnet_library` rules which `src` depends on. + + ### Note + This rule also accepts other attributes defined in `jsonnet_to_json_test` rule + except `golden`, `error` or `regex`. + """ + for key in ["golden", "error", "regex"]: + if key in kwargs: + fail("no such attribute in jsonnet_test", key) + + jsonnet_to_json_test( + name = name, + src = src, + deps = deps + ["@com_github_yugui_jsonnetunit//jsonnetunit"], + **kwargs + ) + diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/matcher.libsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/matcher.libsonnet new file mode 100644 index 0000000..a31edb3 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/matcher.libsonnet @@ -0,0 +1,12 @@ +{ + satisfied: error 'must implement satisfied in concrete matcher', + positiveMessage: error 'must implement positiveMessage in concrete matcher', + negativeMessage: error 'must implement negativeMessage in concreteMatcher', + + matches(expectationType):: self.satisfied == expectationType, + message(expectationType):: + if expectationType then + self.positiveMessage + else + self.negativeMessage, +} diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/std_matchers.libsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/std_matchers.libsonnet new file mode 100644 index 0000000..59d1057 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/std_matchers.libsonnet @@ -0,0 +1,81 @@ +local baseMatcher = import 'matcher.libsonnet'; + +local equalMatcher(actual, expectation) = baseMatcher { + satisfied: actual == expectation, + positiveMessage: 'Expected ' + actual + ' to be ' + expectation, + negativeMessage: 'Expected ' + actual + ' not to be ' + expectation, +}; + +local ltMatcher(actual, expectation) = baseMatcher { + satisfied: actual < expectation, + positiveMessage: 'Expected ' + actual + ' to be less than ' + expectation, +}; + +local leMatcher(actual, expectation) = baseMatcher { + satisfied: actual <= expectation, + positiveMessage: 'Expected ' + actual + + ' to be less than or equal to ' + expectation, +}; + +local gtMatcher(actual, expectation) = baseMatcher { + satisfied: actual > expectation, + positiveMessage: 'Expected ' + actual + + ' to be greater than ' + expectation, +}; + +local geMatcher(actual, expectation) = baseMatcher { + satisfied: actual >= expectation, + positiveMessage: 'Expected ' + actual + + ' to be greater than or equal to ' + expectation, +}; + +local thatMatcher(actual, expectation) = baseMatcher { + satisfied: ( + if std.type(expectation) == 'function' then + expectation(actual) + else + (expectation { actual: actual }).result + ), + positiveMessage: 'Expected ' + actual + ' to satisfy ' + self.description, + description:: ( + if std.type(expectation) == 'function' then + 'the function' + else + local evaluation = expectation { actual: actual }; + if std.objectHas(evaluation, 'description') then + evaluation.description + else + evaluation + ), +}; + +{ + expect: { + matcher: equalMatcher, + expectationType: true, + }, + expectNot: { + matcher: equalMatcher, + expectationType: false, + }, + expectLt: { + matcher: ltMatcher, + expectationType: true, + }, + expectLe: { + matcher: leMatcher, + expectationType: true, + }, + expectGt: { + matcher: gtMatcher, + expectationType: true, + }, + expectGe: { + matcher: geMatcher, + expectationType: true, + }, + expectThat: { + matcher: thatMatcher, + expectationType: true, + }, +} diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test.libsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test.libsonnet new file mode 100644 index 0000000..1448321 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test.libsonnet @@ -0,0 +1,52 @@ +local stdMatchers = import 'std_matchers.libsonnet'; + +local testCase(matchers, name, spec) = ( + local candidates = [ + { + name: name, + matcher: matchers[matcherName].matcher(spec.actual, spec[matcherName]), + expectationType: matchers[matcherName].expectationType, + } + for matcherName in std.objectFields(matchers) + if std.objectHas(spec, matcherName) + ]; + if std.length(candidates) == 0 then + error 'Unrecognized spec ' + spec + ' ' + else if std.length(candidates) > 1 then + error 'Ambiguous expectation in spec ' + spec + else + candidates[0] +); + +local suite(tests) = { + matchers:: stdMatchers, + + result:: [ + testCase(self.matchers, t, tests[t]) + for t in std.objectFields(tests) + if std.startsWith(t, 'test') + ], + + verify: ( + local failures = [ + tc + for tc in self.result + if !tc.matcher.matches(tc.expectationType) + ]; + if std.length(failures) > 0 then + local message = 'Failed %d/%d test cases:\n' % [ + std.length(failures), + std.length(self.result), + ] + std.join('\n', [ + '%s: %s' % [tc.name, tc.matcher.message(tc.expectationType)] + for tc in failures + ]); + error message + else + 'Passed %d test cases' % std.length(self.result) + ), +}; + +{ + suite: suite, +} diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/BUILD.bazel b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/BUILD.bazel new file mode 100644 index 0000000..6cacc72 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/BUILD.bazel @@ -0,0 +1,43 @@ +package(default_visibility = ["//visibility:private"]) + +licenses(["notice"]) # Apache 2.0 + +load("@io_bazel_rules_jsonnet//jsonnet:jsonnet.bzl", "jsonnet_to_json_test") +load("@com_github_yugui_jsonnetunit//jsonnetunit:jsonnetunit.bzl", "jsonnet_test") + +# Tests jsonnet_test rule +jsonnet_test( + name = "test_test", + src = "test_test.jsonnet", +) + +# Tests :jsonnetunit +jsonnet_to_json_test( + name = "test_golden_test", + src = "test_test.jsonnet", + golden = "golden/test_test.golden", + deps = ["@com_github_yugui_jsonnetunit//jsonnetunit"], +) + +jsonnet_to_json_test( + name = "failure_golden_test", + src = "failure_test.jsonnet", + error = 1, + golden = "golden/failure_test.golden", + regex = 1, + deps = ["@com_github_yugui_jsonnetunit//jsonnetunit"], +) + +jsonnet_test( + name = "std_matchers_test", + src = "std_matchers_test.jsonnet", +) + +jsonnet_to_json_test( + name = "std_matchers_failure_test", + src = "std_matchers_failure_test.jsonnet", + error = 1, + golden = "golden/std_matchers_failure_test.golden", + regex = 1, + deps = ["@com_github_yugui_jsonnetunit//jsonnetunit"], +) diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/failure_test.jsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/failure_test.jsonnet new file mode 100644 index 0000000..23889de --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/failure_test.jsonnet @@ -0,0 +1,5 @@ +local test = import 'jsonnetunit/test.libsonnet'; + +test.suite({ + testFailure: { actual: 1 + 1, expect: 3 }, +}) diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/failure_test.golden b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/failure_test.golden new file mode 100644 index 0000000..16a39d4 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/failure_test.golden @@ -0,0 +1,2 @@ +RUNTIME ERROR: Failed 1/1 test cases: +testFailure: Expected 2 to be 3 diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/std_matchers_failure_test.golden b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/std_matchers_failure_test.golden new file mode 100644 index 0000000..abc0150 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/std_matchers_failure_test.golden @@ -0,0 +1,11 @@ +testEq: Expected 1 to be 2 +testGe: Expected 1 to be greater than or equal to 2 +testGt: Expected 1 to be greater than 2 +testGtEq: Expected 1 to be greater than 1 +testLe: Expected 2 to be less than or equal to 1 +testLt: Expected 2 to be less than 1 +testLtEq: Expected 2 to be less than 2 +testNe: Expected 1 not to be 1 +testThatFunction: Expected 1 to satisfy the function +testThatObject: Expected 1 to satisfy \{"actual": 1, "result": false\} +testThatObjectDesc: Expected 1 to satisfy the condition that the value is 2 diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/test_test.golden b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/test_test.golden new file mode 100644 index 0000000..898cbb1 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/golden/test_test.golden @@ -0,0 +1,3 @@ +{ + "verify": "Passed 1 test cases" +} diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_failure_test.jsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_failure_test.jsonnet new file mode 100644 index 0000000..357cd89 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_failure_test.jsonnet @@ -0,0 +1,34 @@ +local test = import 'jsonnetunit/test.libsonnet'; + +test.suite({ + testEq: { actual: 1, expect: 2 }, + testNe: { actual: 1, expectNot: 1 }, + + testLt: { actual: 2, expectLt: 1 }, + testLtEq: { actual: 2, expectLt: 2 }, + testLe: { actual: 2, expectLe: 1 }, + + testGt: { actual: 1, expectGt: 2 }, + testGtEq: { actual: 1, expectGt: 1 }, + testGe: { actual: 1, expectGe: 2 }, + + testThatFunction: { + actual: 1, + expectThat: function(actual) actual == 2, + }, + testThatObject: { + actual: 1, + expectThat: { + actual: error 'to be provided', + result: self.actual == 2, + }, + }, + testThatObjectDesc: { + actual: 1, + expectThat: { + actual: error 'to be provided', + result: self.actual == 2, + description: 'the condition that the value is 2', + }, + }, +}) diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_test.jsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_test.jsonnet new file mode 100644 index 0000000..5214b43 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/std_matchers_test.jsonnet @@ -0,0 +1,65 @@ +local test = import 'jsonnetunit/test.libsonnet'; + +test.suite({ + testExpectNull: { actual: null, expect: null }, + testExpectBool: { actual: true, expect: true }, + testExpectString: { actual: 'str', expect: 'str' }, + testExpectNumber: { actual: 1, expect: 1 }, + testExpectArray: { + actual: [null, true, 'str', 1], + expect: [null, true, 'str', 1], + }, + testExpectObject: { + actual: { a: null, b: true, c: 'str', d: 1 }, + expect: { a: null, b: true, c: 'str', d: 1 }, + }, +} + { + testExpectNotNull: { actual: 1, expectNot: null }, + testExpectNotStringInt: { actual: '1', expectNot: 1 }, + testExpectNotBoolInt: { actual: true, expectNot: 1 }, + testExpectNotArray: { + actual: [1, 2, 3], + expectNot: [1, 4, 3], + }, + testExpectNotObject: { + actual: { a: 1, b: 2, c: 3 }, + expectNot: { a: 1, b: 4, c: 3 }, + }, +} + { + testExpectLt: { + actual: 1, + expectLt: 2, + }, + testExpectLe: { + actual: 1, + expectLe: 2, + }, + testExpectLeEq: { + actual: 1, + expectLe: 1, + }, + testExpectGt: { + actual: 2, + expectGt: 1, + }, + testExpectGe: { + actual: 2, + expectGe: 1, + }, + testExpectGeEq: { + actual: 2, + expectGe: 2, + }, +} + { + testExpectThatFunction: { + actual: 1, + expectThat: function(actual) actual == 1, + }, + testExpectThatObject: { + actual: 1, + expectThat: { + actual: error 'to be provided', + result: self.actual == 1, + }, + }, +}) diff --git a/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/test_test.jsonnet b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/test_test.jsonnet new file mode 100644 index 0000000..62523f6 --- /dev/null +++ b/mixin/vendor/github.com/yugui/jsonnetunit/jsonnetunit/test/test_test.jsonnet @@ -0,0 +1,17 @@ +local matcher = import 'jsonnetunit/matcher.libsonnet'; +local test = import 'jsonnetunit/test.libsonnet'; + +local stubMatcher(actual, expected) = matcher { + satisfied: true, +}; + +test.suite({ + testDummy: { actual: 'something', expectStub: 'something' }, +}) { + matchers+: { + expectStub: { + matcher: stubMatcher, + expectationType: true, + }, + }, +} diff --git a/mixin/vendor/grafana-cloud-integration-utils b/mixin/vendor/grafana-cloud-integration-utils new file mode 120000 index 0000000..3f610b5 --- /dev/null +++ b/mixin/vendor/grafana-cloud-integration-utils @@ -0,0 +1 @@ +github.com/grafana/jsonnet-libs/grafana-cloud-integration-utils \ No newline at end of file diff --git a/mixin/vendor/grafonnet b/mixin/vendor/grafonnet new file mode 120000 index 0000000..fd2d163 --- /dev/null +++ b/mixin/vendor/grafonnet @@ -0,0 +1 @@ +github.com/grafana/grafonnet-lib/grafonnet \ No newline at end of file diff --git a/mixin/vendor/grafonnet-latest b/mixin/vendor/grafonnet-latest new file mode 120000 index 0000000..803696f --- /dev/null +++ b/mixin/vendor/grafonnet-latest @@ -0,0 +1 @@ +github.com/grafana/grafonnet/gen/grafonnet-latest \ No newline at end of file diff --git a/mixin/vendor/grafonnet-v11.0.0 b/mixin/vendor/grafonnet-v11.0.0 new file mode 120000 index 0000000..9ba06e2 --- /dev/null +++ b/mixin/vendor/grafonnet-v11.0.0 @@ -0,0 +1 @@ +github.com/grafana/grafonnet/gen/grafonnet-v11.0.0 \ No newline at end of file diff --git a/mixin/vendor/grafonnet-v11.4.0 b/mixin/vendor/grafonnet-v11.4.0 new file mode 120000 index 0000000..1d81721 --- /dev/null +++ b/mixin/vendor/grafonnet-v11.4.0 @@ -0,0 +1 @@ +github.com/grafana/grafonnet/gen/grafonnet-v11.4.0 \ No newline at end of file diff --git a/mixin/vendor/jsonnetunit b/mixin/vendor/jsonnetunit new file mode 120000 index 0000000..fe5a185 --- /dev/null +++ b/mixin/vendor/jsonnetunit @@ -0,0 +1 @@ +github.com/yugui/jsonnetunit/jsonnetunit \ No newline at end of file diff --git a/mixin/vendor/xtd b/mixin/vendor/xtd new file mode 120000 index 0000000..68b106a --- /dev/null +++ b/mixin/vendor/xtd @@ -0,0 +1 @@ +github.com/jsonnet-libs/xtd \ No newline at end of file